CLI Reference
tokst is an advanced device tool. It connects local Agent endpoints, reports
their health, and supports explicit Session and task operations. Agents use Cloud MCP
for memory, search, context, and memory governance.
Start Here
tokst login
tokst start --agent all
tokst status
tokst doctor
login authorizes the device in a browser. start detects supported local
endpoints, installs TokST-managed bridges, and starts the device Runtime. status shows endpoint health,
models, queues, and tasks. doctor reports recovery actions for connection or
integration issues.
Device Commands
| Command | Purpose |
|---|---|
tokst login | Authorize this device in the browser |
tokst start [--agent <name|all>] | Start supported local Agent endpoints and the device Runtime |
tokst stop [--agent <name|all>] | Stop managed endpoint bridges |
tokst status [--json] | View device, endpoint, queue, and task state |
tokst doctor [--fix-path] | Diagnose local integration and connection problems |
tokst logs [--agent <name>] | Read local bridge and task diagnostics |
tokst update | Update the installed CLI through its current channel |
Use tokst --help for the concise command list. tokst <group> --help provides the full reference for session, task, and agent.
Sessions
Sessions capture a bounded piece of work that needs meaningful checkpoints, evidence, or a durable outcome. Automatic bridges also create Session records from supported endpoint activity.
tokst session start --task "Review deployment readiness" --json
tokst session capture --session <session-id> "Verified the staging checklist" --json
tokst session checkpoint --session <session-id> "Deployment approval pending" --json
tokst session finalize --session <session-id> "Approval completed" --json
tokst session list --json
tokst session candidates --json
Session records retain meaningful evidence and diagnostics. tokst session candidates lists existing review candidates during the compatibility window.
Cloud MCP remains the primary interface for resulting durable memory and shared
context.
Tasks
Create and assign formal tasks in the Dashboard. The CLI inspects and controls tasks from an authenticated device or endpoint.
tokst task list --json
tokst task show <task-id> --json
tokst task claim <task-id> --endpoint <endpoint-id> --json
tokst task cancel <task-id> --reason "No longer required" --json
tokst task retry <task-id> --endpoint <endpoint-id> --mode automatic --json
Task commands preserve assignment, claim, execution, result, cancellation, and retry audit history. Use the Dashboard for task creation, multi-endpoint assignment, review, and archive actions.
Workspace and Atlas Governance
Use the Dashboard for human administration and Cloud MCP for Agent operations. Cloud MCP provides the governed Workspace and Atlas tools, including archival and restore. The CLI keeps device Runtime operations separate from shared data.
Local Agent Delivery
Run the listener only when a connected local endpoint needs direct task or message delivery:
TOKST_AGENT=1 tokst agent listen --json
The listener emits compact JSON Lines and reconnects after temporary network
interruptions. TOKST_AGENT=1 or --agent also enables bounded machine-readable
output for device commands. Add --full for complete JSON and --stdin for
delayed piped input.
Retired Local mode
TokST Local is retired. Existing device files remain untouched, while the CLI no longer opens, exports, restores, synchronizes, or serves Local SQLite profiles. Connected Runtime devices retain only an internal encrypted queue for sanitized delivery recovery. See TokST Local retirement.
Memory Interface
Cloud MCP at https://api.tokst.com/mcp is the only active interface for
memory, search, context, files, Workspaces, and Atlases. See the
MCP reference for tools and Agent setup for
connection instructions.
Authentication and Updates
curl -fsSLo tokst-install.sh https://tokst.com/install.sh
sh tokst-install.sh
tokst login
tokst version --verbose
tokst update
For CI or an unattended service, use a dedicated API key through protected configuration:
tokst login --key tk_live_your_api_key
tokst connection test
tokst logout
Keep API keys, private keys, cookies, and tokens out of source code, shell history, and durable memory records.