> ## Documentation Index > Fetch the complete documentation index at: https://docs.karta.sh/llms.txt > Use this file to discover all available pages before exploring further. # CLI command reference > The full top-level karta CLI surface: setup, deploy, observe, account, API, and management commands. The fastest local reference is always: ```bash theme={null} karta --help karta --help ``` Every command that prints a finite result supports `--json` for scripts. Stream commands such as `dev`, `logs`, git-mode `deploy`, and `completion` reject `--json` instead of ignoring it. ## Setup and auth | Command | Purpose | | ---------------------------------------- | ----------------------------------------------------------------------------------- | | `karta login` | Browser device flow, or `--with-token` from stdin for CI and air-gapped machines. | | `karta auth status` | Show the active profile, host, organization, key name, and scopes. | | `karta auth token` | Print the active token for piping. | | `karta auth logout` | Remove the stored credential from this machine. | | `karta whoami` | Show the authenticated principal. | | `karta create [path] [--harness ]` | Scaffold a starter agent in a supported harness format with a default `karta.toml`. | | `karta setup [path]` | Configure an existing agent folder: name, deploy gate, and delivery method. | | `karta doctor` | Diagnose PATH shadowing, runtime bootstrap, and login state. | ## Local and deploy | Command | Purpose | | ------------------------------- | ------------------------------------------------------------------------------------- | | `karta dev [path]` | Run the agent locally behind the Karta session API. | | `karta deploy [slug]` | Ship the agent through git push or folder upload. | | `karta status` | Show every agent in the current repo with its deploy state. | | `karta rollback [slug] --to vN` | Flip the active release pointer back; slug is inferred from this folder when omitted. | | `karta logs [slug]` | Stream or poll agent logs; slug is inferred from this folder when omitted. | | `karta update` | Self-update standalone installs; npm installs use npm. | | `karta completion ` | Print shell completion scripts. | ## Runtime operations | Command | Purpose | | ----------------------------------------------------- | ----------------------------------------------------------- | | `karta open [target]` | Open hosted chat, console, or account management pages. | | `karta sessions` | List deployed-agent sessions. | | `karta sessions show\|view ` | Render a transcript when transcript access is enabled. | | `karta session ` | Direct alias for viewing one deployed session transcript. | | `karta ps` | Show sessions active right now. | | `karta send ""` | Send one message to the deployed agent; alias: `run`. | | `karta schedules list` | List recurring runs for an agent. | | `karta schedules create` | Create a recurring run; `--run-now` queues one immediately. | | `karta schedules pause\|resume\|run\|delete\|rm ` | Manage an existing recurring run. | ## Agent configuration | Command | Purpose | | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `karta env list` | List production environment bindings. | | `karta env set NAME=value` | Bind an environment value; use `--secret` for secrets. | | `karta env unset NAME` | Remove a production environment binding. | | `karta env pull` | Hydrate `.env` from production bindings. | | `karta env diff` | Compare `.env`, production bindings, and `karta.toml` declarations. | | `karta appearance get\|set` | Read or merge an agent's appearance JSON. | | `karta agent list\|show` | List agents or show one agent with release context and its effective non-secret model route. | | `karta agent sessions [slug]\|sessions show\|view [slug]\|session [slug]` | List or view transcripts without leaving the `agent` namespace. | | `karta agent releases\|activate` | List or activate existing releases. | | `karta agent serving` | Pause or resume serving. | | `karta agent dashboard-edits` | Enable or disable browser-console edits; deploy remains the source update path. | | `karta agent model` | Set an agent connector, opaque model ID, and portable temperature, top-p, output-token, or reasoning controls. | | `karta agent workspace-inspectable` | Enable or disable durable workspace inspection. | | `karta agent delete` | Archive an agent. | ## Management | Command | Purpose | | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | `karta usage` | Current-period totals and budget. | | `karta analytics agents\|users\|instances\|sessions\|models\|cost` | Usage and cost rollups. | | `karta directories instances\|end-users\|users\|sessions` | Agent-scoped durable kartas, verified users, and sessions. | | `karta caps budget [set]` | Inspect or update the monthly budget. | | `karta caps set` | Alias for `karta caps budget set`. | | `karta caps instance\|instance-set` | Inspect or update a durable karta cap. | | `karta caps end-user\|end-user-set` | Inspect or update a verified-user cap. | | `karta caps seat\|seat-set` | Inspect or update a per-seat cap. | | `karta embed-keys list\|create\|rotate\|enable\|disable\|revoke` | Manage publishable widget embed keys. | | `karta webhooks list\|create\|update\|enable\|delete\|rm` | Manage webhook endpoints. | | `karta audit-log` | Export audit events as table, JSON, or CSV. | | `karta keys list\|create\|rename\|revoke` | Manage API keys. | | `karta model-keys list\|create\|revoke` | Manage encrypted provider connectors, including custom HTTPS endpoints and explicit API formats. | | `karta members list\|invite\|set-role\|remove` | Manage organization members and invitations. | | `karta api [METHOD] /path` | Authenticated passthrough for documented public API reads and curated scoped writes. |