Skip to content

docs: fix --install-command spelling and document --include flag #280

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.

Sign up for GitHub

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

Merged
miliberlin merged 3 commits into from
May 4, 2026
Merged

docs: fix --install-command spelling and document --include flag #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f7f299
fix: correct --install-command flag spelling in CLI docs
miliberlin May 4, 2026
2f1dd68
docs: document --include, -i flag for checkly pw-test
miliberlin May 4, 2026
f4ae728
Merge branch 'main' into michelle/fix-install-command-flag
miliberlin May 4, 2026
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
24 changes: 20 additions & 4 deletions cli/checkly-pw-test.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Define `checkly pw-test` specific options before the `--` separator:
| `--create-check` | - | Create a Checkly check from the Playwright test. |
| `--env, -e` | - | Env vars to be passed to the test run. Default: [] |
| `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` |
| `--installCommand` | - | Override the command used to install dependencies before running tests. |
| `--include, -i` | - | File patterns to include when bundling the test project (e.g., `"utils/**/*"`). Can be repeated. |
| `--install-command` | - | Override the command used to install dependencies before running tests. |
| `--location, -l` | - | The location to run the checks at. |
| `--private-location` | - | The private location to run checks at. |
| `--[no-]record` | - | Record test results in Checkly as a test session with full logs, traces and videos. |
Expand Down Expand Up @@ -149,15 +150,30 @@ npx checkly pw-test --env-file="./.env"

</ResponseField>

<ResponseField name="--installCommand" type="string">
<ResponseField name="--include, -i" type="string[]">

File patterns to include when bundling the test project. Use this to add files that aren't automatically detected as dependencies, such as fixtures, helpers, or assets referenced at runtime. Can be specified multiple times to include multiple patterns.

If not provided, falls back to the `checks.include` value in your `checkly.config`.

**Usage:**

```bash Terminal
npx checkly pw-test --include="utils/**/*"
npx checkly pw-test -i="fixtures/**/*" -i="data/*.json"
```

</ResponseField>

<ResponseField name="--install-command" type="string">

Override the command used to install dependencies before running tests. By default, Checkly runs `npm install --dev`. Use this to customize the install step, for example to skip lifecycle scripts or use a different package manager.

**Usage:**

```bash Terminal
npx checkly pw-test --installCommand='npm install --no-scripts'
npx checkly pw-test --installCommand='pnpm install --frozen-lockfile'
npx checkly pw-test --install-command='npm install --no-scripts'
npx checkly pw-test --install-command='pnpm install --frozen-lockfile'
```

</ResponseField>
Expand Down
2 changes: 1 addition & 1 deletion detect/testing/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ npx checkly pw-test --location="eu-west-1" -- --grep="@smoke"
Customize the dependency installation step for the cloud environment:

```bash Terminal
npx checkly pw-test --installCommand='npm install --no-scripts'
npx checkly pw-test --install-command='npm install --no-scripts'
```

Learn more in the [`checkly pw-test` CLI reference](/cli/checkly-pw-test).
Expand Down