Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.runtools.ai/llms.txt

Use this file to discover all available pages before exploring further.

Auth

runtools login [--no-browser]
runtools logout
runtools auth whoami
runtools auth status
runtools auth set-key <key>

runtools auth keys list [--all-org] [--json]
runtools auth keys create <name> [--scope <scope>] [--test] [--expires-in <duration>]
runtools auth keys revoke <id>
runtools auth keys rotate <id> [--name <name>] [--scope <scope>]

OAuth

runtools oauth connect <provider> [--scopes <scopes>] [--no-browser]
runtools oauth status [--all-org] [--json]
runtools oauth disconnect <provider> [--force]
runtools oauth set-default <connection>
Supported providers are defined by the auth service, including Google, GitHub, Slack, Discord, Microsoft, X, LinkedIn, Telegram, WhatsApp, Dropbox, Box, Asana, ClickUp, Intercom, and Monday.

Project

runtools init [name] [--template <template>]

runtools deploy [--tools-only] [--agents-only] [--sandboxes-only]
                [--prune] [--no-prune] [--dry-run] [--json]
deploy creates/updates sandboxes first, then tools, then agents.

Sandboxes

runtools sandbox create \
  [--name <name>] [--template <template>] [--tag <tag>] \
  [--ssh-key <keyId>] [--password <password>] [--no-keys] \
  [--vcpus <count>] [--memory <size>] [--disk <size>] \
  [--idle-timeout <seconds>] [--mount <workspaceId[:path]>] [--json]

runtools sandbox list [--status <status>] [--all-org] [--watch] [--json]
runtools sandbox get [id] [--json]
runtools sandbox exec <id> <command> [--timeout <ms>] [--cwd <path>] [--json] [--quiet]
runtools sandbox ssh [id] [--port <port>]
runtools sandbox url <id> [--port <port>] [--open] [--json]
runtools sandbox logs <id> [--tail <lines>] [--follow]
runtools sandbox watch [id] [--json]
runtools sandbox pause [id] [--json]
runtools sandbox resume [id] [--json]
runtools sandbox destroy [id] [--force] [--json]
Sandbox checkpoint, restore, clone, and file-sync commands are not implemented in the current CLI. --mount is repeatable and accepts workspaceId, workspaceId:/workspace, or workspaceId=/workspace/subpath. Mount paths must be /workspace or a subpath. Use mounts for sandbox-backed agents that need durable storage and persistent filesystem memory.

SSH Keys

runtools ssh-key list [--all-org] [--json]
runtools ssh-key add [name] [--file <path>] [--key <publicKey>] [--org-wide] [--default] [--always-include]
runtools ssh-key remove <id> [--force]
runtools ssh-key set-default <id> [--org-wide]
runtools ssh-key set-always-include <id> [--org-wide] [--disable]

Agents

runtools agent list [--all-org] [--json]
runtools agent get <slug> [--json]
runtools agent run <slug> <prompt> [--max-tokens <n>] [--max-turns <n>]
                    [--no-stream] [--json] [--thread <id>] [--new-thread]
                    [--attach <path>] [--device <name-or-id>]
runtools agent delete <slug> [--force] [--json]
runtools agent publish <slug> [--visibility <tier>] [--org] [--unpublish]
runtools agent install <slug> [--sandbox <name>]
runtools agent sandbox <agent-slug> <sandbox-name>
runtools agent threads list <slug> [--limit <n>] [--json]
runtools agent threads delete <threadId> <slug> [--json]

Tools

runtools tool search <query> [--json]
runtools tool list [--installed] [--custom] [--all-org] [--json]
runtools tool install <slug>
runtools tool uninstall <slug>
runtools tool exec <slug> --action <action> [--params <json>] [--params-file <path>]
                  [--credentials <json>] [--credentials-file <path>] [--json]
runtools tool credentials <slug> [--json <json>] [--clear]
runtools tool publish <slug> [--org] [--unpublish]
runtools tool delete <slug> [--force]

Secrets

runtools secret set <name> [value] [--scope <scope>] [--category <category>]
                    [--description <desc>] [--org-wide] [--json]
runtools secret list [--category <category>] [--user-only] [--org-only] [--all-org] [--json]
runtools secret get <name> [--reveal] [--org-wide] [--user-id <userId>] [--json]
runtools secret rotate <name> [value] [--scope <scope>] [--category <category>]
                       [--description <desc>] [--org-wide] [--json]
runtools secret delete <name> [--org-wide] [--user-id <userId>] [--force] [--json]

Workflows

runtools workflow list [--all-org] [--json]
runtools workflow run <workflow> [prompt] [--input <json>] [--state <json>]
                      [--draft] [--version <number>] [--events] [--json]
runtools workflow resume <runId> [--reject] [--json]
runtools workflow publish <workflow> [--visibility <tier>] [--org] [--unpublish] [--json]
runtools workflow unpublish <workflow> [--json]
runtools workflow versions <workflow> [--json]
runtools workflow rollback <workflow> <version> [--json]

runtools workflow trigger list <workflow> [--json]
runtools workflow trigger create <workflow> --type <cron|webhook>
                                  [--name <name>] [--cron <expr>]
                                  [--timezone <tz>] [--secret <secret>] [--json]
runtools workflow trigger enable <workflow> <triggerId>
runtools workflow trigger disable <workflow> <triggerId>
runtools workflow trigger delete <workflow> <triggerId>

Threads

runtools threads list [--all-org] [--archived] [--limit <n>] [--json]
runtools threads get <threadId> [--json]
runtools threads events <threadId> [--rollout-id <id>] [--all-rollouts] [--limit <n>] [--json]
runtools threads rollouts <threadId> [--json]
runtools threads compact <threadId> [--json]
runtools threads archive <threadId> [--json]
runtools threads stream <threadId> [--json]

Devices

runtools devices list [--all-org] [--devices-only] [--sandboxes-only] [--json]
runtools devices rename <id> <name> [--json]
runtools devices revoke <id> [--json]
runtools devices audit [--limit <n>] [--json]
runtools devices register --public-key <key> [--name <name>] [--hostname <hostname>]
                          [--os <os>] [--app-version <version>] [--json]

Installable Agents

runtools installable-agent list [--all-org] [--json]
runtools installable-agent installs [--all-org] [--json]
runtools installable-agent install <slug> --sandbox <sandboxId> [--ref <ref>] [--repo <url>] [--json]

Usage

runtools usage [--all-org] [--json]