Skip to main content

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.

@karta/cli is the command-line client for the hosted platform. It wraps @karta/sdk and adds project setup, deployment, rollback, and log streaming against your account. It’s the CLI used in the Quickstart.
This is distinct from the Python karta CLI, which is for local development and serving. This one (@karta/cli, npm) operates on your hosted projects and is authenticated by a kt_live_… key.

​
Install & authenticate

npm install -g @karta/cli
karta init           # auth (or create an account), create the project, add the 'karta' git remote
karta whoami         # active profile + visible key prefix
karta init is the one-step setup from the Quickstart. If you only need to authenticate an existing project, karta login prompts for your kt_live_… key and writes ~/.karta/config.toml (mode 0600). Named profiles are supported; select a non-default with --profile <name>.

​
Commands

CommandScopePurpose
karta initwriteAuth, create the project, add the karta git remote. (preview)
karta open <slug>readOpen the project’s hosted URL in a browser. (preview)
karta login—Authenticate and validate your key.
karta whoamireadShow active profile and key prefix.
karta keys listreadList API keys.
karta keys create <name> [--scope …]adminMint a key (plaintext shown once).
karta keys revoke <id>adminRevoke a key.
karta usagereadCurrent-period totals and budget.
karta projects listreadList your projects.
karta projects show <slug>readProject header + recent releases.
karta projects releases <slug>readAll releases for a project.
karta deploy <slug> --commit <sha>writeEnqueue a build for a commit.
karta rollback <slug> --to vNadminFlip to a previous release.
karta logs <slug> [--tail] [--since <iso>]readStream logs (SSE) or poll.

​
Deploy and roll back

There are two ways to deploy. The headline path is git push karta — push a commit to the karta remote karta init set up, and Karta builds and activates a release. Equivalently, karta deploy enqueues a build for an explicit commit: 
git push karta main                      # headline path (see Quickstart)
# — or, drive a build explicitly:
karta deploy my-app --commit 1a2b3c4     # build + activate the next version

karta projects releases my-app           # watch versions appear
karta rollback my-app --to v3            # instant pointer flip back
karta logs my-app --tail                 # follow build/runtime logs
Preview. karta init, karta open, and the git push karta remote are part of the rolling-out push-to-deploy experience. The wired path today is karta deploy --commit (and a GitHub webhook) against a repo-linked project. See the deploy loop status.
See Releases & rollback for the full deploy loop, CI wiring, and the underlying API.