astro/docs/cli.md

## 👩🏽‍💻 Command Line Interface

### 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
```

#### `--version`

Print the Astro version number and exit.

#### `--help`

Print the help message and exit.

### Commands

#### `astro dev`

Runs the Astro development server. This starts an HTTP server that responds to requests for pages stored in `astro/pages` (or which folder is specified in your [configuration](../README.md##%EF%B8%8F-configuration)).

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`.
CLI docs (#121) * Start of cli docs * Document the CLI Also adds support for the `--config` option and `--port` option for the dev server. * Add tests for --config and --port flags * Add port to validateConfig 2021-04-22 12:25:57 +00:00			`## 👩🏽‍💻 Command Line Interface`

			`### 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`
			```

			#### `--version`

			`Print the Astro version number and exit.`

			#### `--help`

			`Print the help message and exit.`

			`### Commands`

			#### `astro dev`

			Runs the Astro development server. This starts an HTTP server that responds to requests for pages stored in `astro/pages` (or which folder is specified in your [configuration](../README.md##%EF%B8%8F-configuration)).

Support 500 pages in the dev server (#131) * Support 500 pages * Document custom 400/500 pages * Remove search from any pages not the 500 page * fix(kitchen-sink): add snowpack.config.js * fix(examples): add snowpack.config.js * style: redesign built-in 500 page Co-authored-by: Nate Moore <nate@skypack.dev> 2021-04-26 20:42:11 +00:00			`See the [dev server](./dev.md) docs for more information on how the dev server works.`

CLI docs (#121) * Start of cli docs * Document the CLI Also adds support for the `--config` option and `--port` option for the dev server. * Add tests for --config and --port flags * Add port to validateConfig 2021-04-22 12:25:57 +00:00			`__Flags__`

			##### `--port`

			Specifies should port to run on. Defaults to `3000`.