The CLI
Capture screenshots directly from your terminal. Run any preset created on the dashboard — the CLI launches a local browser and executes the opcode program deterministically.
Quick start
The default setup path is a single init command. Generate a CLI key in the dashboard, then run:
npx autokap@latest init --cli-key <your-cli-key>Optional installers if you prefer a global binary:
curl -fsSL https://autokap.app/install.sh | shirm https://autokap.app/install.ps1 | iexInstall
Global install is optional. The CLI-first setup above works without it.
npm install -g autokapOne-step setup
init authenticates the CLI and installs the default preset skill in one step.
npx autokap@latest init --cli-key <your-cli-key>Advanced: use npx autokap@latest skill --agent <agent> only when you want an agent-specific export outside the default init flow.
Run a preset
AutoKap capture execution is CLI-first. Run presets locally via Playwright after the preset has been created or updated.
autokap run <preset-id>autokap run --local <preset-id>Use --program <file> only as a local debug override. The normal path is to run the saved preset directly.
Commands
| Command | Description |
|---|---|
| autokap init | Authenticate and install the AI skill in one step |
| autokap login <key> | Authenticate with your CLI key |
| autokap logout | Remove stored credentials |
| autokap whoami | Show the account linked to the current CLI key |
| autokap ping | Verify CLI connection and confirm the stored key is still valid |
| autokap run <preset-id> | Run a preset capture using local Playwright |
| autokap run <preset-id> --headed | Show the browser window for debugging |
| autokap project list | List accessible projects as JSON |
| autokap project get <project-id> | Get a single project as JSON |
| autokap project create --name <name> --url <url> | Create a project and print its ID |
| autokap preset info <preset-id> | Get structured JSON with endpoints, variants, and URL parameters |
| autokap capture list | List captures as JSON |
| autokap usage | Show the current billing-period usage as JSON |
| autokap endpoints list --preset <id> | List dev link endpoints as JSON or table |
| autokap endpoints get <endpoint-id> | Get a single dev link endpoint as JSON |
| autokap endpoints export --preset <id> | Export dev link endpoints as JSON or CSV |
| autokap auth capture <project-id> | Capture a browser session for a session account |
| autokap auth account list <project-id> | List project credential accounts as JSON |
| autokap auth account create <project-id> --name <name> | Create a project credential account and print its ID |
| autokap auth account update <project-id> --account <name-or-id> | Update a project credential account |
| autokap auth account delete <project-id> --account <name-or-id> | Delete an unused project credential account |
| autokap auth session clear <project-id> --account <name-or-id> | Clear the stored browser session for a session account |
| autokap proxy register --project <id> --proxy-url <url> | Register a user-side proxy for dev links |
| autokap proxy verify --project <id> | Verify the configured proxy for a project |
| autokap skill | Export the AI agent skill bundle |
| autokap --version | Show the installed version |
How it works
- Generate a CLI key from the dashboard.
- Run
npx autokap@latest init --cli-key <your-cli-key>once in your repo. - Create or update presets, then run them with
autokap run.