OnepilotDownload

The Onepilot CLI

Onepilot talks to your servers over plain SSH, so most things work without installing anything. The onepilot command line helper is what you add when you want the parts that need something running on the host: pairing by QR code, sessions that survive a disconnect, and reaching a machine that sits behind a router.

Install it

One command, on the machine you want to reach. It ships through npm and nowhere else.

npm install -g onepilot --include=optional

Then pair the machine with your phone. Run this on the host, and scan the code it prints with the Onepilot app.

onepilot pair

That is the whole quick start. The pairing guide walks through what the command installs and what the output means.

What it gives you

  • Pairing by QR code. Add a server by scanning, instead of typing an address and a key on a phone keyboard.
  • Sessions that survive. Your shell runs on the host rather than inside the app, so losing signal or closing Onepilot does not kill the work.
  • Reaching machines behind a router. A host with no public address can dial out and hold the connection open, so you can reach a home or office machine without a VPN or port forwarding.
  • Host health. The app reads CPU, memory, disk, network, and container state from the host to draw its graphs and send alerts.

What it is not

It is not a login shell, a package manager, or a replacement for SSH. It does not open an inbound port: the daemon listens on loopback only, and the tunnel, when you use one, is an outbound connection the host makes itself.

Commands you actually run

The CLI has a handful of commands meant for humans. Most of its surface exists for the app and the background service to talk to each other, and you should never need to invoke those by hand.

  • onepilot pair to add a server, and its cleanup flags to remove access.
  • onepilot upgrade to update, which is the only update command you need.
  • onepilot serve, list, and kill to inspect and manage sessions.
  • onepilot monitor and onepilot keepawake as kill switches for the two background behaviors.

The command reference covers each one with its flags. Run onepilot help on the host for the same list from the version you have installed.

Which version am I on

onepilot --version

The app compares that against the latest published npm version and tells you when an update is available. Nothing about the version is hardcoded on either side.