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