Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli): add help and version tasks #1266

Merged
merged 2 commits into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 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,10 +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`
Alias: `stencil -v`

| Flag | Description |
|------|-------------|
| `--help` | Display the help output explaining the different flags. | `-h` |
| `--version` | Prints the current Stencil version. | `-v` |
Prints the version of Stencil to the terminal.
14 changes: 9 additions & 5 deletions versioned_docs/version-v4.0/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,10 +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`
Alias: `stencil -v`

| Flag | Description |
|------|-------------|
| `--help` | Display the help output explaining the different flags. | `-h` |
| `--version` | Prints the current Stencil version. | `-v` |
Prints the version of Stencil to the terminal.
14 changes: 9 additions & 5 deletions versioned_docs/version-v4.1/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,10 +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`
Alias: `stencil -v`

| Flag | Description |
|------|-------------|
| `--help` | Display the help output explaining the different flags. | `-h` |
| `--version` | Prints the current Stencil version. | `-v` |
Prints the version of Stencil to the terminal.
14 changes: 9 additions & 5 deletions versioned_docs/version-v4.2/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,10 +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`
Alias: `stencil -v`

| Flag | Description |
|------|-------------|
| `--help` | Display the help output explaining the different flags. | `-h` |
| `--version` | Prints the current Stencil version. | `-v` |
Prints the version of Stencil to the terminal.
14 changes: 9 additions & 5 deletions versioned_docs/version-v4.3/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,10 +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`
Alias: `stencil -v`

| Flag | Description |
|------|-------------|
| `--help` | Display the help output explaining the different flags. | `-h` |
| `--version` | Prints the current Stencil version. | `-v` |
Prints the version of Stencil to the terminal.
14 changes: 9 additions & 5 deletions versioned_docs/version-v4.4/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,10 +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`
Alias: `stencil -v`

| Flag | Description |
|------|-------------|
| `--help` | Display the help output explaining the different flags. | `-h` |
| `--version` | Prints the current Stencil version. | `-v` |
Prints the version of Stencil to the terminal.
14 changes: 9 additions & 5 deletions versioned_docs/version-v4.5/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,10 +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`
Alias: `stencil -v`

| Flag | Description |
|------|-------------|
| `--help` | Display the help output explaining the different flags. | `-h` |
| `--version` | Prints the current Stencil version. | `-v` |
Prints the version of Stencil to the terminal.
14 changes: 9 additions & 5 deletions versioned_docs/version-v4.6/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,10 +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`
Alias: `stencil -v`

| Flag | Description |
|------|-------------|
| `--help` | Display the help output explaining the different flags. | `-h` |
| `--version` | Prints the current Stencil version. | `-v` |
Prints the version of Stencil to the terminal.
14 changes: 9 additions & 5 deletions versioned_docs/version-v4.7/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,10 +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`
Alias: `stencil -v`

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