Home Console
Get started

Quickstart

Install the CLI, start a computer, run something, stop it.

1. Install the CLI

On macOS or Linux:

curl -fsSL workpaper.co/install | sh

It downloads the right build for your machine, checks it against its published checksum, and puts workpaper in /usr/local/bin, or ~/.local/bin if it can't write there. On Windows, download workpaper-windows-amd64.exe, or use the command above inside WSL.

Check it's working:

workpaper doctor

2. Start a computer

Every computer needs a name. You'll use it to come back to it later.

workpaper run my-agent

In under a second you're in a shell on your new computer:

Creating your computer
✓ Linux
✓ 2 vCPU · 4 GB
✓ Internet
✓ Private and isolated
✓ Ready in 190ms

Free trial · 60m 00s remaining

user@my-agent:~$

You don't need an account for this. Your first computer is a free trial with 60 minutes of runtime.

3. Use it

It's a normal Debian Linux machine. Try:

sudo apt-get install -y nodejs npm
git clone https://github.com/pallets/click && cd click

Leave the shell with exit. The computer keeps running.

4. Run commands without a shell

workpaper exec my-agent -- python3 --version

exec prints the output and exits with the command's exit code, so it works in scripts.

5. Stop it

workpaper stop my-agent

Billing stops the same second. Everything on it is kept. workpaper run my-agent brings it back exactly as it was.

Next