diff options
author | 2021-07-15 14:13:35 -0400 | |
---|---|---|
committer | 2021-07-15 14:13:35 -0400 | |
commit | 166e22bdf35b9751dc42f5cc6cb27a99b077df93 (patch) | |
tree | e8643360c2250dda82ebf95b62281978547d5188 /docs/reference/cli-reference.md | |
parent | fb8bf7ec43f7b09348c12d5ff9f81131c70ef5e9 (diff) | |
download | astro-166e22bdf35b9751dc42f5cc6cb27a99b077df93.tar.gz astro-166e22bdf35b9751dc42f5cc6cb27a99b077df93.tar.zst astro-166e22bdf35b9751dc42f5cc6cb27a99b077df93.zip |
merge in docs site (#705)
Diffstat (limited to 'docs/reference/cli-reference.md')
-rw-r--r-- | docs/reference/cli-reference.md | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/docs/reference/cli-reference.md b/docs/reference/cli-reference.md deleted file mode 100644 index 9c718900c..000000000 --- a/docs/reference/cli-reference.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: ~/layouts/Main.astro -title: CLI Reference ---- - -## Commands - -### `astro dev` - -Runs the Astro development server. This starts an HTTP server that responds to requests for pages stored in `src/pages` (or which folder is specified in your [configuration](/reference/configuration-reference)). - -See the [dev server](./dev.md) docs for more information on how the dev server works. - -**Flags** - -#### `--port` - -Specifies should port to run on. Defaults to `3000`. - -### `astro build` - -Builds your site for production. - -## Global Flags - -### `--config path` - -Specify the path to the config file. Defaults to `astro.config.mjs`. Use this if you use a different name for your configuration file or have your config file in another folder. - -```shell -astro --config config/astro.config.mjs dev -``` - -### `--project-root path` - -Specify the path to the project root. If not specified the current working directory is assumed to be the root. - -The root is used for finding the Astro configuration file. - -```shell -astro --project-root examples/snowpack dev -``` - -### `--reload` - -Clears the cache (dependencies are built within Astro apps). - -### `--verbose` - -Enables verbose logging, which is helpful when debugging an issue. - -### `--version` - -Print the Astro version number and exit. - -### `--help` - -Print the help message and exit. |