Command line
Every pi-kit command: the service, models, the browser, phones, and other instances.
The
pi-kit command runs and manages the pi-kit service on this computer, also over SSH. A server install puts it on your PATH. With the desktop app, choose Install the pi-kit command in Settings → General → Background.pi-kit --help prints the same list.Service#
The service is pi-kit's backend. It keeps background agents and phone access working when the pi-kit window is closed. Keep running when pi-kit is closed in Settings → General does the same as
install and uninstall.| Command | What it does |
|---|---|
pi-kit service status | Whether the background service is installed and running (exit code 3: not running; --json for scripts) |
pi-kit service install | Start pi-kit's backend at sign-in, and now (--level boot: at boot, with nobody signed in) |
pi-kit service uninstall | Stop it and no longer start it at sign-in |
pi-kit service start | Start it now |
pi-kit service stop | Stop it until the next sign-in or start |
pi-kit service restart | Stop it and start it again |
pi-kit service logs | Print the end of service.log and where the logs are |
pi-kit serve | Run it in this terminal instead, for a container or another supervisor |
pi-kit update [--check] | Update this server install to the latest release (the desktop app updates itself) |
Models#
| Command | What it does |
|---|---|
pi-kit login [<provider>] | Sign in to a provider with its own flow (--api-key or --oauth where it offers both) |
pi-kit login --local <url> | Add a local model server (llama.cpp, llama-swap, Ollama, any OpenAI-compatible one) |
pi-kit logout <provider> | Remove a provider's stored sign-in |
pi-kit model [<provider>/<id>] | Show or set the default model for new threads |
Browser#
| Command | What it does |
|---|---|
pi-kit open | Start the pi-kit app when it is installed; otherwise open pi-kit in this computer's browser with a one-time link (over SSH it prints it) |
pi-kit open --browser | The browser, also when the app is installed |
pi-kit open --revoke | Sign out every browser pi-kit open signed in |
Desktop app#
| Command | What it does |
|---|---|
pi-kit desktop install | Download the pi-kit app of this server's version from its release, check it, install it for you and start it; it attaches to this server's service |
Phone and tailnet#
| Command | What it does |
|---|---|
pi-kit remote status | Whether this pi-kit is reachable on your tailnet (exit code 3: it is not) |
pi-kit remote enable [--port N] | Publish it on your tailnet with Tailscale Serve (the HTTPS port it used last, else 8443) |
pi-kit remote disable | Stop publishing it |
pi-kit pair | A pairing link and QR code for a phone; you approve it after comparing codes |
pi-kit devices | Paired devices and the requests waiting for you |
pi-kit devices approve <request> | Approve a request whose confirmation code matches the device's |
pi-kit devices reject <request> | Reject a request |
pi-kit devices revoke <device> | Sign a paired device out |
See Remote access for the Tailscale setup.
Instances#
| Command | What it does |
|---|---|
pi-kit peers | This instance, its paired instances and the requests waiting for you |
pi-kit peers invite | A short-lived invitation for another pi-kit instance |
pi-kit peers connect | Pair with the instance whose invitation you paste |
pi-kit peers approve <pair-id> | Approve a request once its confirmation code matches the other side (--allow-relay also lets this instance's approved phones reach the other one) |
pi-kit peers reject <pair-id> | Reject a request |
pi-kit peers unpair <peer-id> | Stop a pairing |
pi-kit peers key-file --yes | Seal the instance key with an owner-only file, for machines without a keychain |