CLI overview

What the paperctl CLI does, how it relates to the paperd daemon and paper console, and where to go for install, capture, and session workflows.

The paperctl CLI runs locally and captures supported agent sessions to paper console. This page is the map of the CLI docs — what the pieces are and which page gets you to your outcome. For an end-to-end walkthrough, see the Quickstart. Setting up with a coding agent? Point it at papercompute.com/start.md — an agent-followable runbook of the setup steps.

The pieces

  • paperctl — the command you run: install, sign in, launch agents, list and search sessions.
  • paperd — the local daemon paperctl sets up after you authenticate. It routes agent traffic and uploads sessions in the background. Check it with paperctl status; start it with paperctl init.
  • paper console — where captured sessions land: console.papercompute.com.

Supported agents: Claude Code, Codex, and Pi, each launched with paperctl start <agent> or automatically via shell routing.

Set up

  1. Install paperctl
  2. Authenticate
  3. Capture with Claude Code, Codex, or Pi
  4. Optional but recommended: automatic shell routing, so plain claude, codex, and pi always capture

Work with sessions

Common commands

Task Command
Start Claude Code through paper paperctl start claude
Start Codex through paper paperctl start codex
Start Pi through paper paperctl start pi
Check proxy status paperctl status
View logs paperctl logs --follow
Switch orgs paperctl org select
Add a teammate paperctl org membership add [email protected]
Search your sessions paperctl search "..."
List recent sessions paperctl sessions list
Update the CLI paperctl upgrade

Every command, flag, and output shape: CLI command reference. Gateway and backend configuration for teams: Custom backends. Setup issues: Troubleshooting.

Frequently asked questions

How do I update the paperctl CLI?+
Run paperctl upgrade. It checks the published version, replaces the binary in place, and restarts the daemon. Check your installed version with paperctl --version.
What is paperd?+
paperd is the local daemon the paperctl CLI runs after you authenticate. It routes supported agent sessions to paper console. Check it with paperctl status and start it with paperctl init.
Which clients can I run through the paperctl CLI, and how?+
Claude Code, Codex, and Pi. Claude Code is one step: paperctl start claude. Pi is one step too: paperctl start pi. Codex also runs with paperctl start codex, but how it authenticates with OpenAI depends on your access: ChatGPT-plan sign-in, your own OpenAI API key, or a shared team key. See Capture with Codex for the option that matches you.
How do I switch between organizations?+
Run paperctl org select. The new selection takes effect the next time the paperctl CLI starts; if it is already running, restart it with paperctl init.
Where does the paperctl CLI store credentials?+
In ~/.config/paper/. Removing this directory wipes your login; running paperctl login again recreates it.
Copied to clipboard