Skip to content

CLI

The subcommands talk to the server over its socket, so a second terminal can drive the agent while kyotoagent serve stays up. Every command follows the same choice of socket or --url / KYOTOAGENT_URL.

Commands

Command What it does
kyotoagent Opens the newest session for the current directory
kyotoagent --yolo Opens it with yolo on
kyotoagent attach <id> Opens the list with that session selected
kyotoagent attach <id> --yolo The same, with yolo on
kyotoagent serve Starts the server
kyotoagent serve --listen <addr> Also serves HTTPS + HTTP/2 on that TCP address, and writes listen to config
kyotoagent new [repo-id] Creates a session in a registered repository, or offers repository selection in a terminal
kyotoagent repos Lists registered repository ids, names, and paths
kyotoagent pair <host:port> Prints a temporary pairing link and QR code, valid for 10 minutes
kyotoagent sessions Lists the sessions, one plain-text row each
kyotoagent log [id] Prints the event log of a session
kyotoagent cancel [id] Cancels the current turn of a session
kyotoagent login Signs in to Grok with a device code
kyotoagent logout Forgets the Grok session
kyotoagent provider Prints the current model server
kyotoagent provider use <id> Selects a table in the file
kyotoagent provider add <id> --base-url <url> --model <model> [--api-key-env <name>] Inserts a table and selects it
kyotoagent doctor Checks the socket, the model catalog, and the closeout file
kyotoagent doctor --url <connection-link> The same, against a remote address

Reaching the server

  • kyotoagent --url <connection-link> or KYOTOAGENT_URL uses HTTPS with HTTP/2 and the signed token from kyotoagent pair.
  • Bare kyotoagent still uses the unix socket.

new, repos, sessions, log, cancel, and attach follow the same choice.

kyotoagent with no arguments opens the newest session for the current directory. kyotoagent log and kyotoagent cancel name the newest session in the current directory when no id is given. If the socket is down, the program tells you to start kyotoagent serve.

Terminal window
kyotoagent serve --listen 0.0.0.0:7841
kyotoagent
kyotoagent --url 'kyotoagent://box.tailnet.ts.net:7841?token=<generated-token>' sessions
kyotoagent attach <id>