Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
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
8 changes: 4 additions & 4 deletions cli/checkly-login.mdx → cli/account/checkly-login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,10 @@ If the authentication browser window doesn't open:

If you have access to multiple Checkly accounts, you'll be prompted to select which account to use as the active account for CLI operations.

You can also switch accounts later using [`checkly switch`](/cli/checkly-switch).
You can also switch accounts later using [`checkly switch`](/cli/account/checkly-switch).

## Related Commands

- [`checkly logout`](/cli/checkly-logout) - Sign out of your Checkly account
- [`checkly whoami`](/cli/checkly-whoami) - Display current account information
- [`checkly switch`](/cli/checkly-switch) - Switch between multiple accounts
- [`checkly logout`](/cli/account/checkly-logout) - Sign out of your Checkly account
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

heads up: you'll have to set "a thousand" redirects in the marketing repo then. :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Urf. True. Are there ways to keep folders without changing the URL? 🤓

- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information
- [`checkly switch`](/cli/account/checkly-switch) - Switch between multiple accounts
8 changes: 4 additions & 4 deletions cli/checkly-logout.mdx → cli/account/checkly-logout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ The command removes authentication tokens stored locally in:

## After Logout

Once logged out, you'll need to run [`checkly login`](/cli/checkly-login) before using other CLI commands that require authentication.
Once logged out, you'll need to run [`checkly login`](/cli/account/checkly-login) before using other CLI commands that require authentication.

## Related Commands

- [`checkly login`](/cli/checkly-login) - Authenticate with your Checkly account
- [`checkly whoami`](/cli/checkly-whoami) - Display current account information
- [`checkly switch`](/cli/checkly-switch) - Switch between multiple accounts
- [`checkly login`](/cli/account/checkly-login) - Authenticate with your Checkly account
- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information
- [`checkly switch`](/cli/account/checkly-switch) - Switch between multiple accounts
4 changes: 2 additions & 2 deletions cli/checkly-runtimes.mdx → cli/account/checkly-runtimes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,5 +119,5 @@ Check the [Checkly changelog](https://feedback.checklyhq.com/changelog) for runt

## Related Commands

- [`checkly test`](/cli/checkly-test) - Test checks with current runtime
- [`checkly deploy`](/cli/checkly-deploy) - Deploy checks to specified runtime
- [`checkly test`](/cli/testing/checkly-test) - Test checks with current runtime
- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy checks to specified runtime
4 changes: 2 additions & 2 deletions cli/checkly-switch.mdx → cli/account/checkly-switch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,5 @@ If an expected account doesn't appear:

## Related Commands

- [`checkly login`](/cli/checkly-login) - Sign in to your Checkly account
- [`checkly whoami`](/cli/checkly-whoami) - Display current account information
- [`checkly login`](/cli/account/checkly-login) - Sign in to your Checkly account
- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information
2 changes: 1 addition & 1 deletion cli/checkly-whoami.mdx → cli/account/checkly-whoami.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ environment variables to setup authentication.

## Related Commands

- [`checkly login`](/cli/checkly-login) - Sign in to your Checkly account
- [`checkly login`](/cli/account/checkly-login) - Sign in to your Checkly account
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,6 @@ npx checkly incidents resolve <id> --no-notify-subscribers

## Related Commands

- [`checkly status-pages`](/cli/checkly-status-pages) - List and inspect status pages
- [`checkly checks`](/cli/checkly-checks) - List and inspect checks
- [`checkly whoami`](/cli/checkly-whoami) - Display current account information
- [`checkly status-pages`](/cli/communicate/checkly-status-pages) - List and inspect status pages
- [`checkly checks`](/cli/monitoring/checkly-checks) - List and inspect checks
- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information
Original file line number Diff line number Diff line change
Expand Up @@ -166,5 +166,5 @@ npx checkly status-pages get 12345 --output=json

## Related Commands

- [`checkly checks`](/cli/checkly-checks) - List and inspect checks
- [`checkly whoami`](/cli/checkly-whoami) - Display current account information
- [`checkly checks`](/cli/monitoring/checkly-checks) - List and inspect checks
- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information
4 changes: 2 additions & 2 deletions cli/checkly-env.mdx → cli/configure/checkly-env.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -208,5 +208,5 @@ For check-specific or group-specific variables, use the web UI or configure them

## Related Commands

- [`checkly test`](/cli/checkly-test) - Test your setup before deployment
- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration
- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment
- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your Checkly configuration
4 changes: 2 additions & 2 deletions cli/checkly-import.mdx → cli/configure/checkly-import.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,5 +162,5 @@ npx checkly import cancel

## Related Commands

- [`checkly deploy`](/cli/checkly-deploy) - Deploy imported resources
- [`checkly test`](/cli/checkly-test) - Test imported checks locally
- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy imported resources
- [`checkly test`](/cli/testing/checkly-test) - Test imported checks locally
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,5 @@ The following Playwright config values are supported and will be synced:

## Related Commands

- [`checkly test`](/cli/checkly-test) - Test with synchronized configuration
- [`checkly deploy`](/cli/checkly-deploy) - Deploy with updated settings
- [`checkly test`](/cli/testing/checkly-test) - Test with synchronized configuration
- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy with updated settings
2 changes: 1 addition & 1 deletion cli/dependencies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ new BrowserCheck('login-check', {
})
```

After running [`npx checkly deploy`](/cli/checkly-deploy), you can see in the Web UI that the helper file `login-helper.ts` was also uploaded for this Check.
After running [`npx checkly deploy`](/cli/monitoring/checkly-deploy), you can see in the Web UI that the helper file `login-helper.ts` was also uploaded for this Check.

![login check with helper file in dependencies](/images/docs/images/cli/local-dependency.png)

Expand Down
6 changes: 3 additions & 3 deletions cli/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,12 +130,12 @@ You can reference that file in the `test` as follows:
npx checkly test --env-file="./.env"
```

You can also pull in the variables from your account and store them in a file using [the `npx checkly env pull` command](/cli/checkly-env#pull).
You can also pull in the variables from your account and store them in a file using [the `npx checkly env pull` command](/cli/configure/checkly-env#pull).
See the examples below.

### Managing Remote Environment Variables

Manage your remote environment variables with the CLI using the [`checkly env` command](/cli/checkly-env). You can list, add, update, remove
Manage your remote environment variables with the CLI using the [`checkly env` command](/cli/configure/checkly-env). You can list, add, update, remove
and export your global variables.

List all your stored variables and lock it.
Expand All @@ -158,7 +158,7 @@ npx checkly env pull .env.prod

Reference that file in your `test` command.

<Tip>[See the full reference documentation for the `checkly env` command](/cli/checkly-env).</Tip>
<Tip>[See the full reference documentation for the `checkly env` command](/cli/configure/checkly-env).</Tip>

## Securing Environment Variables

Expand Down
6 changes: 3 additions & 3 deletions cli/checkly-checks.mdx → cli/monitoring/checkly-checks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,6 @@ npx checkly checks get 12345 --results-limit=25

## Related Commands

- [`checkly status-pages`](/cli/checkly-status-pages) - List and inspect status pages
- [`checkly trigger`](/cli/checkly-trigger) - Trigger checks on-demand
- [`checkly whoami`](/cli/checkly-whoami) - Display current account information
- [`checkly status-pages`](/cli/communicate/checkly-status-pages) - List and inspect status pages
- [`checkly trigger`](/cli/monitoring/checkly-trigger) - Trigger checks on-demand
- [`checkly whoami`](/cli/account/checkly-whoami) - Display current account information
4 changes: 2 additions & 2 deletions cli/checkly-deploy.mdx → cli/monitoring/checkly-deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -180,5 +180,5 @@ The Checkly CLI evaluates Git information from your local or CI environment on a

## Related Commands

- [`checkly login`](/cli/checkly-login) - Log in to your Checkly account
- [`checkly test`](/cli/checkly-test) - Test your setup before deployment
- [`checkly login`](/cli/account/checkly-login) - Log in to your Checkly account
- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,5 @@ Please confirm by typing the project name "Website Monitoring":

## Related Commands

- [`checkly deploy`](/cli/checkly-deploy) - Deploy resources to Checkly
- [`checkly test`](/cli/checkly-test) - Test your setup before deployment
- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy resources to Checkly
- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment
Original file line number Diff line number Diff line change
Expand Up @@ -347,9 +347,9 @@ Run your deployed checks before promoting code to production:
npx checkly trigger --tags staging --record --test-session-name "Pre-prod validation"
```

<Tip>If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/checkly-test) to validate your preview environment with the updated monitoring configuration.</Tip>
<Tip>If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/testing/checkly-test) to validate your preview environment with the updated monitoring configuration.</Tip>

## Related Commands

- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration
- [`checkly test`](/cli/checkly-test) - Test your setup before deployment
- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your Checkly configuration
- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment
4 changes: 2 additions & 2 deletions cli/checkly-pw-test.mdx → cli/testing/checkly-pw-test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -393,5 +393,5 @@ npx checkly pw-test -- test.spec.ts

## Related Commands

- [`checkly test`](/cli/checkly-test) - Test your setup before deployment
- [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration
- [`checkly test`](/cli/testing/checkly-test) - Test your setup before deployment
- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your Checkly configuration
6 changes: 3 additions & 3 deletions cli/checkly-test.mdx → cli/testing/checkly-test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,6 @@ npx checkly test --env ENVIRONMENT_URL="https://preview.acme.com" --env PASSWORD

## Related Commands

- [`checkly pw-test`](/cli/checkly-pw-test) - Run Playwright tests in the Checkly cloud
- [`checkly trigger`](/cli/checkly-trigger) - Run deployed checks on-demand
- [`checkly deploy`](/cli/checkly-deploy) - Deploy your application
- [`checkly pw-test`](/cli/testing/checkly-pw-test) - Run Playwright tests in the Checkly cloud
- [`checkly trigger`](/cli/monitoring/checkly-trigger) - Run deployed checks on-demand
- [`checkly deploy`](/cli/monitoring/checkly-deploy) - Deploy your application
2 changes: 1 addition & 1 deletion constructs/check-group-v2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ When referencing existing groups with `fromId()`, note:
- You cannot filter tests by group tags since group properties aren't available locally
- Checks won't inherit the group's frequency. This only works for groups defined in the CLI project

If you need these features, you can either import the group using the [Checkly import feature](/cli/checkly-import) (e.g. `npx checkly import check-group:123`) or define a new group directly in your project.
If you need these features, you can either import the group using the [Checkly import feature](/cli/configure/checkly-import) (e.g. `npx checkly import check-group:123`) or define a new group directly in your project.

## Shared Settings in Groups with Different Monitor Types

Expand Down
2 changes: 1 addition & 1 deletion constructs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ If multiple projects are using the same project `logicalId`, deploying one proje
The project `logicalId` can be configured in the project's [global configuration](/constructs/project).

<Note>
When changing the logical ID of a project you will keep all resources on your Checkly account, unless you run [`npx checkly destroy`](/cli/checkly-destroy/) to remove the old project.
When changing the logical ID of a project you will keep all resources on your Checkly account, unless you run [`npx checkly destroy`](/cli/monitoring/checkly-destroy/) to remove the old project.
</Note>

## Programming with Constructs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Checkly automatically collect Network Waterfalls & Performance signals (**Web Vi
<Callout type="warning" emoji="⚠️">
Checkly only collects tracing and web vitals data if your browser check meets the following criteria:
- It is based on **Playwright**.
- It runs on any **runtime above [2021.06](/cli/checkly-runtimes)**
- It runs on any **runtime above [2021.06](/cli/account/checkly-runtimes)**
</Callout>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ There are three things you should be aware of:


If you have an existing `playwright.config.ts` or `playwright.config.js` file in your project that you want to import,
you can simply run the [sync-playwright](/cli/checkly-sync-playwright)
you can simply run the [sync-playwright](/cli/configure/checkly-sync-playwright)

```bash
npx checkly sync-playwright
Expand Down
2 changes: 1 addition & 1 deletion detect/testing/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Customize the dependency installation step for the cloud environment:
npx checkly pw-test --installCommand='npm install --no-scripts'
```

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

## Analyze local test results

Expand Down
57 changes: 41 additions & 16 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -533,23 +533,48 @@
{
"group": "CLI Commands",
"pages": [
"cli/checkly-checks",
"cli/checkly-deploy",
"cli/checkly-destroy",
"cli/checkly-env",
"cli/checkly-import",
"cli/checkly-incidents",
"cli/checkly-login",
"cli/checkly-logout",
"cli/checkly-pw-test",
"cli/checkly-runtimes",
"cli/checkly-skills",
"cli/checkly-status-pages",
"cli/checkly-switch",
"cli/checkly-sync-playwright",
"cli/checkly-test",
"cli/checkly-trigger",
"cli/checkly-whoami"
{
"group": "Account",
"pages": [
"cli/account/checkly-login",
"cli/account/checkly-logout",
"cli/account/checkly-switch",
"cli/account/checkly-whoami",
"cli/account/checkly-runtimes"
]
},
{
"group": "Configure",
"pages": [
"cli/configure/checkly-env",
"cli/configure/checkly-import",
"cli/configure/checkly-sync-playwright"
]
},
{
"group": "Testing",
"pages": [
"cli/testing/checkly-test",
"cli/testing/checkly-pw-test"
]
},
{
"group": "Monitoring",
"pages": [
"cli/monitoring/checkly-deploy",
"cli/monitoring/checkly-destroy",
"cli/monitoring/checkly-trigger",
"cli/monitoring/checkly-checks"
]
},
{
"group": "Communicate",
"pages": [
"cli/communicate/checkly-incidents",
"cli/communicate/checkly-status-pages"
]
}
]
}
]
Expand Down
4 changes: 2 additions & 2 deletions guides/playwright-testing-to-monitoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Here's how Checkly enhances the process of releasing new code:
1. **Write the Playwright Script**: Automate the login, product search, and checkout steps. Run initial tests through the Checkly network to make sure it's working from all your users' geo-locations.
2. **Configure Monitoring Settings**: Define how often the script should run (e.g., every 15 minutes) and from which locations (e.g., Ireland, Frankfurt).
3. **Set Up Alerts**: Notify your team if a Playwright test fails, ensuring quick resolution of issues.
4. **Deploy to Production**: Use [Checkly's CLI to deploy](/cli/checkly-deploy) your Playwright tests and start monitoring your production environment.
4. **Deploy to Production**: Use [Checkly's CLI to deploy](/cli/monitoring/checkly-deploy) your Playwright tests and start monitoring your production environment.

With Checkly running your Playwright monitors, you can find and resolve issues before your users are affected.

Expand All @@ -116,7 +116,7 @@ If you want to learn how to apply different Playwright settings depending on the

Once your Playwright tests run locally, in CI/CD, and as scheduled monitors, they need to be aware of their execution environment.

A local Playwright test executed with `npx playwright test` needs to target `localhost`, a CI/CD test run via [`npx checkly pw-test`](/cli/checkly-pw-test) or [`npx checkly test`](/cli/checkly-test) needs to target environment-specific preview URLs, and global production monitoring might need to be aware of its execution region.
A local Playwright test executed with `npx playwright test` needs to target `localhost`, a CI/CD test run via [`npx checkly pw-test`](/cli/testing/checkly-pw-test) or [`npx checkly test`](/cli/testing/checkly-test) needs to target environment-specific preview URLs, and global production monitoring might need to be aware of its execution region.

To differentiate your Playwright test runs in Checkly, use the [provided environment variables](/detect/synthetic-monitoring/playwright-checks/environment-variables).

Expand Down
2 changes: 1 addition & 1 deletion quickstarts/playwright-check.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ npx checkly test --record --env ENVIRONMENT=staging
**Difference between `checkly test` and `checkly pw-test`:**

- `checkly test` - Runs check suites defined in `checkly.config.ts` and `check.ts` files
- `checkly pw-test` - Runs any Playwright tests defined in your `playwright.config.ts`, directly on Checkly's cloud infrastructure. See the [CLI reference](/cli/checkly-pw-test).
- `checkly pw-test` - Runs any Playwright tests defined in your `playwright.config.ts`, directly on Checkly's cloud infrastructure. See the [CLI reference](/cli/testing/checkly-pw-test).
</Info>

## Step 5: Deploy to Production Monitoring
Expand Down