diff options
| author |  Nate Moore <natemoo-re@users.noreply.github.com>
| 2021-04-26 16:54:20 -0500 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-04-26 15:54:20 -0600 |
| commit | dea1a6dfc9dec54034d2b872b4cd36c0174814c6 (patch) | |
| tree | 49569a511201b4defc23b6654b475e458452596a /examples/snowpack/src/pages/reference/cli-command-line-interface.md | |
| parent | 0ea4a986e207238bf0ac1db841b2a5d5b567d84d (diff) | |
| download | astro-dea1a6dfc9dec54034d2b872b4cd36c0174814c6.tar.gz astro-dea1a6dfc9dec54034d2b872b4cd36c0174814c6.tar.zst astro-dea1a6dfc9dec54034d2b872b4cd36c0174814c6.zip | |
Update defaults directory structure to `src` and `dist` (#132)
* chore: update defaults in docs
* chore: update config defaults
* test: update tests to config defaults
* chore: update gitignore to new defaults
* docs: update readme to new defaults
* chore: update examples to new defaults
* chore: update default exclude in lang server
* chore: update tests
* test: fix failing tests
* chore: update www defaults
Diffstat (limited to 'examples/snowpack/src/pages/reference/cli-command-line-interface.md')
| -rw-r--r-- | examples/snowpack/src/pages/reference/cli-command-line-interface.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/examples/snowpack/src/pages/reference/cli-command-line-interface.md b/examples/snowpack/src/pages/reference/cli-command-line-interface.md new file mode 100644 index 000000000..338eee415 --- /dev/null +++ b/examples/snowpack/src/pages/reference/cli-command-line-interface.md @@ -0,0 +1,41 @@ +--- +layout: ../../layouts/content.astro +title: Command Line API +description: The Snowpack Command Line tool's API, commands, and flags. +--- + +### Commands + +``` +$ snowpack --help + +snowpack init Create a new project config file. +snowpack dev Develop your app locally. +snowpack build Build your app for production. + +... +``` + +### Flags + +```bash +# Show helpful info +$ snowpack --help + +# Show additional debugging logs +$ snowpack --verbose + +# {devOptions: {open: 'none'}} +$ snowpack dev --open none + +# {buildOptions: {clean: true/false}} +$ snowpack build --clean +$ snowpack build --no-clean +``` + +**CLI flags will be merged with (and take priority over) your config file values.** Every config value outlined below can also be passed as a CLI flag. Additionally, Snowpack also supports the following flags: + +- **`--config [path]`** Set the path to your project config file. +- **`--help`** Show this help. +- **`--version`** Show the current version. +- **`--reload`** Clear the local cache. Useful for troubleshooting installer issues. |