Skip to content

docs(cli): document multi-account use, login --wait and whoami --output json [RED-1122] - #566

Open
hlenke wants to merge 2 commits into
mainfrom
hannes/red-1122-multi-account
Open

hlenke wants to merge 2 commits into
mainfrom
hannes/red-1122-multi-account

Conversation

@hlenke

@hlenke hlenke commented Oct 11, 2026

Copy link
Copy Markdown
Member

Linear: RED-1122

Documents checkly/checkly-cli#1528. Like #561 and #564, this describes behaviour that ships in the next CLI release, so merge after checkly/checkly-cli#1528 is released.

Changes

  • cli/authentication.mdx
    • A new "Working with several accounts" section: your login works with all of your accounts, the default account, CHECKLY_ACCOUNT_ID for one command, and CHECKLY_ACCOUNT_ID in a shell or .env (for example, to pin a project to an account while each developer uses their own login).
    • "From CI": only CHECKLY_API_KEY switches the CLI to API key credentials.
  • cli/checkly-login.mdx
    • The new --wait option, and the AI agent flow: the agent relays the code, then runs login --wait, so you don't have to say when you're done.
    • How CHECKLY_API_KEY and CHECKLY_ACCOUNT_ID affect login.
  • cli/checkly-whoami.mdx
    • Output now shows the default and the other accounts.
    • --output json and its fields (accountSource, defaultAccount, …).
    • Without credentials it starts the login. The page used to say it runs without authentication.
  • cli/checkly-switch.mdx
    • Behaviour without a terminal (CI error listing the accounts) and under an AI agent (JSON choices).
    • The precedence warning when CHECKLY_ACCOUNT_ID is set.
    • The success output now matches the CLI.

The example output was taken from a build of the CLI PR; IDs and names are replaced with the placeholders the pages already use.

🤖 Generated with Claude Code

…ut json [RED-1122]

Documents checkly/checkly-cli#1528:
- authentication: a "Working with several accounts" section (default
  account, `CHECKLY_ACCOUNT_ID` for one command or pinned in a shell or
  `.env`), and that only `CHECKLY_API_KEY` switches to API key credentials.
- checkly login: `--wait`, the AI agent flow without "tell me when you're
  done", and how the two environment variables affect the login.
- checkly whoami: the default and other accounts, `--output json` and its
  fields, and the inline login when not authenticated.
- checkly switch: what it does without a terminal or under an AI agent, and
  the `CHECKLY_ACCOUNT_ID` precedence warning.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Oct 12, 2026, 2:34 PM

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
staging — 7fe87d75 Deployed Oct 12, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant