Reference

Commands

Every CLI command.

[name] is optional and means the computer you used last. <name> is required. Every command takes --json.

Command	What it does
`workpaper run <name> [-- cmd]`	Create the computer, or wake it if it exists. Then open a shell, or run `cmd` in a real terminal, so interactive programs like `claude` or `vim` work. Without a name it uses the last one; a new computer always needs a name.
`workpaper ls`	List your computers and how long each has left before it stops.
`workpaper exec [name] -- cmd`	Run one command and exit with its exit code.
`workpaper cp SRC DST`	Copy a file. The computer side is `name:path` or `:path`. See Copying files.
`workpaper stop [name]`	Stop it. Billing stops; everything is kept.
`workpaper start [name]`	Start a stopped computer.
`workpaper fork [name] <new>`	Copy a computer into a new one, running programs and all. Needs an account.
`workpaper logs [name]`	Show the computer's logs.
`workpaper rm <name>`	Delete it for good.
`workpaper auth login [--device]`	Sign in with your browser, or with a code.
`workpaper auth logout`	Sign out on this device.
`workpaper auth status`	Show whether you're signed in or on the free trial.
`workpaper doctor`	Check each piece between you and your computers.
`workpaper version`	Show the installed version. To update, run the install command again.

Names

Lowercase letters, numbers and -, up to 32 characters, like my-agent. In a terminal, the CLI asks for one if you leave it out.

Variable	Effect
`WORKPAPER_NAME`	The computer to use when a command doesn't name one.
`--env NAME` (flag)	On `run` and `exec`: pass the variable `NAME` from your machine to the command, e.g. an API key. Only the name goes on the command line.
`WORKPAPER_TIMEOUT`	How long a computer runs per start before it stops, like `30m`. Default and maximum: `1h`.