# CLI reference

Every command of the kaab command-line interface, generated from the CLI itself.

Every page in this section is written by `kaab docs generate --format md` from the commands themselves. The [CLI guide](https://docs.kaab.ist/guides/cli) covers installation, profiles and exit codes.

| Command | What it does |
|---|---|
| [`kaab auth login`](https://docs.kaab.ist/reference/cli/kaab-auth-login) | Check an API key and store it in a profile |
| [`kaab auth logout`](https://docs.kaab.ist/reference/cli/kaab-auth-logout) | Forget a profile and its keys |
| [`kaab auth status`](https://docs.kaab.ist/reference/cli/kaab-auth-status) | Show the profiles and check the selected one's key |
| [`kaab auth`](https://docs.kaab.ist/reference/cli/kaab-auth) | Store, show and forget API keys |
| [`kaab completion bash`](https://docs.kaab.ist/reference/cli/kaab-completion-bash) | Generate the autocompletion script for bash |
| [`kaab completion fish`](https://docs.kaab.ist/reference/cli/kaab-completion-fish) | Generate the autocompletion script for fish |
| [`kaab completion powershell`](https://docs.kaab.ist/reference/cli/kaab-completion-powershell) | Generate the autocompletion script for powershell |
| [`kaab completion zsh`](https://docs.kaab.ist/reference/cli/kaab-completion-zsh) | Generate the autocompletion script for zsh |
| [`kaab completion`](https://docs.kaab.ist/reference/cli/kaab-completion) | Generate the autocompletion script for the specified shell |
| [`kaab credits`](https://docs.kaab.ist/reference/cli/kaab-credits) | Show the credit balance and its lots |
| [`kaab jobs cancel`](https://docs.kaab.ist/reference/cli/kaab-jobs-cancel) | Cancel a job (refunds what it reserved and did not use) |
| [`kaab jobs get`](https://docs.kaab.ist/reference/cli/kaab-jobs-get) | Print a job (its data, or with --json its envelope) |
| [`kaab jobs input`](https://docs.kaab.ist/reference/cli/kaab-jobs-input) | Answer a job waiting for an input |
| [`kaab jobs list`](https://docs.kaab.ist/reference/cli/kaab-jobs-list) | List jobs, newest first |
| [`kaab jobs resume`](https://docs.kaab.ist/reference/cli/kaab-jobs-resume) | Resume a job that needs attention |
| [`kaab jobs run`](https://docs.kaab.ist/reference/cli/kaab-jobs-run) | Create a job and, with --wait, print its data |
| [`kaab jobs snapshot`](https://docs.kaab.ist/reference/cli/kaab-jobs-snapshot) | Download a job's page snapshot (the final step's by default) |
| [`kaab jobs steps`](https://docs.kaab.ist/reference/cli/kaab-jobs-steps) | List a job's steps with their status and timing |
| [`kaab jobs takeover`](https://docs.kaab.ist/reference/cli/kaab-jobs-takeover) | Open a live browser on a parked job and print its URL |
| [`kaab jobs`](https://docs.kaab.ist/reference/cli/kaab-jobs) | Run, inspect and answer jobs |
| [`kaab open job`](https://docs.kaab.ist/reference/cli/kaab-open-job) | Open a job's page in the panel |
| [`kaab open`](https://docs.kaab.ist/reference/cli/kaab-open) | Open a resource in the panel |
| [`kaab programs alias set`](https://docs.kaab.ist/reference/cli/kaab-programs-alias-set) | Point ALIAS at VERSION (alias latest is managed by publishing) |
| [`kaab programs alias`](https://docs.kaab.ist/reference/cli/kaab-programs-alias) | Point a program's aliases at versions |
| [`kaab programs diff`](https://docs.kaab.ist/reference/cli/kaab-programs-diff) | Print the JSON Patch from version V1 to version V2 |
| [`kaab programs lint`](https://docs.kaab.ist/reference/cli/kaab-programs-lint) | Lint a definition; exit 1 when it has errors |
| [`kaab programs list`](https://docs.kaab.ist/reference/cli/kaab-programs-list) | List programs |
| [`kaab programs pull`](https://docs.kaab.ist/reference/cli/kaab-programs-pull) | Print (or save) a program version's definition |
| [`kaab programs push`](https://docs.kaab.ist/reference/cli/kaab-programs-push) | Create the program a definition file names, or add a version to it |
| [`kaab programs`](https://docs.kaab.ist/reference/cli/kaab-programs) | Push, pull, lint and compare programs |
| [`kaab proposals approve`](https://docs.kaab.ist/reference/cli/kaab-proposals-approve) | Approve a proposal; --promote publishes it as a new version |
| [`kaab proposals list`](https://docs.kaab.ist/reference/cli/kaab-proposals-list) | List proposals (pending by default) |
| [`kaab proposals reject`](https://docs.kaab.ist/reference/cli/kaab-proposals-reject) | Reject a proposal |
| [`kaab proposals show`](https://docs.kaab.ist/reference/cli/kaab-proposals-show) | Print a proposal |
| [`kaab proposals`](https://docs.kaab.ist/reference/cli/kaab-proposals) | Review healing proposals |
| [`kaab schedules create`](https://docs.kaab.ist/reference/cli/kaab-schedules-create) | Create a schedule |
| [`kaab schedules list`](https://docs.kaab.ist/reference/cli/kaab-schedules-list) | List schedules |
| [`kaab schedules pause`](https://docs.kaab.ist/reference/cli/kaab-schedules-pause) | Pause a schedule |
| [`kaab schedules resume`](https://docs.kaab.ist/reference/cli/kaab-schedules-resume) | Resume a paused schedule |
| [`kaab schedules runs`](https://docs.kaab.ist/reference/cli/kaab-schedules-runs) | List a schedule's runs, newest first |
| [`kaab schedules`](https://docs.kaab.ist/reference/cli/kaab-schedules) | Run programs on a cron |
| [`kaab sessions create`](https://docs.kaab.ist/reference/cli/kaab-sessions-create) | Store a Playwright storage state as a session |
| [`kaab sessions delete`](https://docs.kaab.ist/reference/cli/kaab-sessions-delete) | Delete a session |
| [`kaab sessions list`](https://docs.kaab.ist/reference/cli/kaab-sessions-list) | List sessions |
| [`kaab sessions verify`](https://docs.kaab.ist/reference/cli/kaab-sessions-verify) | Run a session's validity probe (costs verify credits) |
| [`kaab sessions`](https://docs.kaab.ist/reference/cli/kaab-sessions) | Store, check and delete browser sessions |
| [`kaab usage`](https://docs.kaab.ist/reference/cli/kaab-usage) | Show usage grouped by day, program, tier or tag |
| [`kaab version`](https://docs.kaab.ist/reference/cli/kaab-version) | Print the CLI's version |
| [`kaab webhooks create`](https://docs.kaab.ist/reference/cli/kaab-webhooks-create) | Create an endpoint; its secret is printed once |
| [`kaab webhooks deliveries`](https://docs.kaab.ist/reference/cli/kaab-webhooks-deliveries) | List an endpoint's deliveries, newest first |
| [`kaab webhooks list`](https://docs.kaab.ist/reference/cli/kaab-webhooks-list) | List endpoints |
| [`kaab webhooks test`](https://docs.kaab.ist/reference/cli/kaab-webhooks-test) | Send a ping to an endpoint and show its answer |
| [`kaab webhooks`](https://docs.kaab.ist/reference/cli/kaab-webhooks) | Manage webhook endpoints |
| [`kaab`](https://docs.kaab.ist/reference/cli/kaab) | The Kaabist command-line interface |