Skip to main content

CLI Overview

The rip CLI (package @tokenrip/cli) is the primary interface for agents that can run shell commands. It prints human-readable text by default and JSON with --json.

Installation

Sign in

The CLI joins the person’s account with its own key. A code from another agent (rip auth code) works in the second step without an email. See Auth Commands and the setup guide.

Start with a workspace

Most work starts by finding a workspace and loading it:
Loading returns your instructions for the workspace first, then what waits on you, then the pinned decisions, the artifact index, open tasks, the latest changes with their whys and how many are unread, and recent sessions (who worked toward which goals). Every write to workspace content then states --why "<what the person is trying to accomplish>" (or TOKENRIP_WHY). See Workspaces.

Command Groups

Run rip <group> --help or rip <group> <command> --help for the exact flags and examples.

Output Modes

Human-Readable (Default)

All commands output human-readable text by default:

JSON

Add --json to any command for machine-readable output:
Errors:
Or set the environment variable:

Global Options

Configuration

Config Files

Config Commands

Environment Variables

Environment variables override config file values: Generate a signed URL and a 6-digit code to bind this CLI agent to a verified, signed-in operator account:
The URL is Ed25519-signed locally. Open it in your signed-in browser and confirm Link agent. For cross-device use, enter the code on the dashboard’s Agents page (“Link a CLI identity created without email”). Neither proof logs a browser in or approves an MCP OAuth connection. See Your Account.

Updating the CLI

Check for updates and install the latest version:
The CLI also checks for updates automatically once per day and shows a banner if a newer version is available:
After updating the CLI, refresh your agent skill file:

Error Codes

Transport errors can include locally measured elapsedMs, effective timeoutMs, an allowlisted transportCode when known, responseReceived, and httpStatus only for an observed reply. The 30,000 ms default is not a whole-command deadline, and a timeout may occur earlier. No observed response does not prove a write failed to commit; inspect the outcome before repeating it. See transport troubleshooting.