Skip to content

Commit

Permalink
docs(cli): add help and version tasks
Browse files Browse the repository at this point in the history
add explicit sections for the help and version tasks, rather than
grouping them under the vague header 'stencil'
  • Loading branch information
rwaskiewicz committed Nov 2, 2023
1 parent 84f2f42 commit f6b498c
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions docs/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ src
└── page-home.tsx
```

## `stencil help`

Aliases: `stencil --help`, `stencil -h`

Prints various tasks that can be run and their associated flags to the terminal.

## `stencil test`

Tests a Stencil project. The flags below are the available options for the `test` command.
Expand All @@ -94,15 +100,8 @@ Tests a Stencil project. The flags below are the available options for the `test
| `--devtools` | Opens the dev tools panel in Chrome for end-to-end tests. Setting this flag will disable `--headless` |
| `--headless` | Sets the headless mode to use in Chrome for end-to-end tests. `--headless` and `--headless=true` will enable the "old" headless mode in Chrome, that was used by default prior to Chrome v112. `--headless=new` will enable the new headless mode introduced in Chrome v112. See [this article](https://developer.chrome.com/articles/new-headless/) for more information on Chrome's new headless mode. |

## `stencil version`

## `stencil`

| Flag | Description |
|------|-------------|
| `--help` | Display the help output explaining the different flags. | `-h` |
| `--version` | Prints the current Stencil version. | `-v` |


## `stencil generate <sub-folder>`
Alias: `stencil -v`

Starts the interactive component generator. You can specify one or more sub-folders to generate the component in.
Prints the version of Stencil to the terminal.

0 comments on commit f6b498c

Please sign in to comment.