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.

​
Overview

The CLI manages authentication, projects, sandboxes, agents, tools, workflows, secrets, SSH keys, usage, threads, and devices.
@runtools/cli is not published to npm yet. Use the source repo during early access.

​
Quick Start

runtools login
runtools sandbox create --name my-env --template base-ubuntu
runtools sandbox create --name agent-env --template base-ubuntu --mount 9b84ef42-9c3a-4930-9d4c-45c7f5c22d8e:/workspace
runtools sandbox exec my-env "echo hello"
runtools agent run code-assistant "Create a REST API"
runtools deploy --dry-run
Use --mount <workspaceId[:path]> when a sandbox-backed agent needs durable storage. The path defaults to /workspace.

​
Command Groups

GroupCommands
Authlogin, logout, auth whoami, auth status, auth set-key, auth keys ...
OAuthoauth connect, oauth status, oauth disconnect, oauth set-default
Projectinit, deploy
Sandboxessandbox create/list/get/exec/ssh/url/logs/watch/pause/resume/destroy
SSH keysssh-key list/add/remove/set-default/set-always-include
Agentsagent list/get/run/delete/publish/install/sandbox/threads
Toolstool search/list/install/uninstall/exec/credentials/publish/delete
Secretssecret set/list/get/rotate/delete
Workflowsworkflow list/run/resume/publish/unpublish/versions/rollback/triggers
Threadsthreads list/get/events/rollouts/compact/archive/stream
Devicesdevices list/rename/revoke/audit/register
Usageusage

​
Global Patterns

Many list and mutation commands support --json for scripts: 
runtools sandbox list --json
runtools agent run code-assistant "Summarize this repo" --json
Admin-only broader org views use --all-org where supported.

​
Environment Variables

VariablePurpose
RUNTOOLS_API_KEYAPI key for non-interactive auth
RUNTOOLS_API_URLOrchestrator API override
RUNTOOLS_AUTH_URLAuth service override
RUNTOOLS_TOOLS_URLTools service override
RUNTOOLS_CONVEX_URLRealtime sandbox status override

​
Config Files

The CLI stores local credentials and settings in ~/.runtools/. Use API keys for CI: 
runtools auth set-key "$RUNTOOLS_API_KEY"

​
Next Steps

Installation

Run the CLI from source.

Authentication

Sign in, create keys, and use CI auth.

Commands Reference

See implemented commands and flags.