Install and upgrade
The CLI ships through npm and nowhere else. There is no download page, no install script to pipe into a shell, and no binary to fetch by hand.
Install
Run this on the machine you want to reach from your phone.
npm install -g onepilot --include=optionalRequirements
- Node.js 18 or newer, only to run the installer and the launcher.
- An SSH server on the host. The CLI does not install or configure one for you.
Supported platforms
| Platform | Architectures |
|---|---|
| macOS | Apple silicon and Intel |
| Linux | arm64 and x64 |
| Windows | x64 only |
Where it lands
Wherever your npm global prefix points. If that location is owned by root, npm will need elevation, and the usual fix is to point the prefix somewhere in your home directory rather than reaching for sudo.
npm config get prefix
which onepilotInstall it as the user that will own the sessions. Installing as root and pairing as yourself is the most common way to end up with a helper that cannot write the state it needs.
Upgrade
One command. It reinstalls from npm and then hands the running daemon over to the new binary in place, so open sessions stay alive across the upgrade.
onepilot upgradeExpect one of these on success:
upgradedwhen a daemon was running and took over the new version.upgraded (no running daemon)when there was nothing to hand over.
You can also upgrade from the app, which runs the same command over SSH. Do not use plain npm update: it replaces the files without telling the running daemon, so the version you are talking to and the version on disk drift apart.
Verify the install
onepilot --version
onepilot serveserve is safe to run repeatedly. It starts the daemon if it is not running and simply reprints the port if it is, so it doubles as a health check. If it prints a port number, the install is good.
Removing it
Uninstalling the npm package leaves the pairing keys, the local state, and any boot service behind. The cleanup guide removes those in the right order.