paperboat
Sign in Install

Quickstart

Install pb, add a second machine and open a terminal on it. The full reference is built into pb.

  1. Install Paperboat on the computer you are at

    The installer installs pb and starts its background service. When it finishes, your browser opens: sign in and approve this computer.

    $ curl -fsSL https://get.pprbt.dev/install | bash
    > irm https://get.pprbt.dev/install.ps1 | iex
    View install script View install script

  2. Check that it is healthy

    pb doctor checks sign-in, the background service and connectivity, and says what to do about anything that is wrong.

    $ pb doctor
$ pb auth status

  3. Add a second machine

    Run the same install line there. On a server with no browser, pb prints a link and a short code; open the link on any device and approve. Or create a ready-made install line that needs no approval:

    $ pb machine add --name studio
    1. 1

      Prints install commands for Linux, macOS and Windows with a one-time token. Run it on the new machine within ten minutes.

  4. See your machines

    Names are what you type everywhere else. Rename one with pb machine rename.

    $ pb environments
NAME    STATE   PLATFORM      ID
laptop  online  darwin/arm64  machine_2f6c0b1e-77a4-4c1d-b0f3-5d9a41c8e2a7
studio  online  linux/amd64   machine_8a1d5c2e-3b47-4f0e-9d62-1c7e5b0a4f93

  5. Open a terminal on the other one

    You are in a shell on studio. Close the window whenever you like; run the same command to come back to it.

    $ pb connect studio

  6. Share something

    Start any web server and give it a public address. Press Ctrl+C to take it down.

    $ pb preview 3000
Preview ready
https://quiet-river-lantern-4821.pprbt.app -> http://127.0.0.1:3000

Press Ctrl+C to stop

What to read next

Each feature has a page with its commands, real output and limits.

Where the reference lives

Generated from the same code as pb, and browsable in the repository.

pbWith no arguments, opens a home screen: machines, sessions, previews, tunnels and every command, searchable.
pb help, pb <command> --helpEvery command explains itself, with examples. Add --json for a structured description.
man pb, man pb-tunnel-createManual pages are installed with pb. Spaces in a command become hyphens.
pb doctor [machine]Diagnoses this computer, or the path to another machine. --repair fixes what it can.
pb bugreportBuilds a diagnostic bundle with secrets and contents removed, for a support request.
pb updateUpdates now. By default pb updates itself at 04:00 local time; pb update settings changes that.
pb completion zshShell completion for zsh (also bash and fish), including your machine names.
pb uninstallRemoves Paperboat from this machine completely. Files in the Inbox are kept.

Start with the machine in front of you

Install Paperboat here, then on a second machine. Free for personal use, no card needed.

$ curl -fsSL https://get.pprbt.dev/install | bash
> irm https://get.pprbt.dev/install.ps1 | iex
View install script View install script