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.

The karta CLI ships with karta-python (pip install karta-python). It’s the fastest way to develop a harness app, run a local server, and inspect live sessions.
karta --version
karta login                 # store your username for CLI auth
karta whoami                # show the logged-in username
karta cleanup               # stop instances/servers, remove ~/.karta state

Develop: karta dev

A hot-reloading REPL against a folder — no server needed. The fastest inner loop while authoring an app.
karta dev .                              # REPL against the current folder
karta dev ./my-app --message "Hello"     # one-shot, then exit
karta dev . --thinking --verbose         # show reasoning + raw events
karta dev . --config ./karta.jsonc       # custom config path
FlagPurpose
pathThe harness app folder (default .).
--messageSend one message and exit (otherwise interactive).
--configPath to karta.jsonc (default ./karta.jsonc).
--thinkingSurface reasoning events.
--verboseRender raw harness events.
--harness-argPass a raw argument through to the harness (repeatable).

Serve: karta serve

Start the FastAPI HTTP server — the uniform session API, multi-tenant and instance-managed, that survives restarts.
karta serve                  # 0.0.0.0:8000
karta serve --port 9000
This is the surface documented in the API reference.

Run a registered project: karta run

Run a project you’ve registered by name. Starts serve if it isn’t already up.
karta run my-app                          # run an instance
karta run my-app --message "Hello"        # send a message to it
karta run my-app --host 0.0.0.0 --port 8000 --heartbeat

Command map

karta
├── login / whoami / cleanup       account + local state
├── dev <path>                     local hot-reload REPL
├── serve                          start the HTTP server
├── run <name>                     run a registered project instance
├── project
│   ├── add <path> [name]          register a project
│   ├── list                       list registered projects
│   └── remove <name>              unregister a project
└── session
    ├── list                       list active sessions
    ├── send <id> <message>        one-off message to a session
    ├── logs <id>                  message history
    ├── interact <id>              interactive REPL for a session
    ├── pause <id>                 pause a session's instance
    └── resume <id> [target]       resume from harness storage
See Projects & sessions for the project and session subcommands in detail.
This is the Python CLI for local development and serving. The separate @karta/cli (npm) is for the hosted platform — deploying releases, rolling back, and streaming logs against your account.