Command reference.
Every koidog node command and flag.
Pairing.
koidog pair <code> --server <url> [--name <name>]
Pairs this machine with a Koidog server.
- <code>
- 8-character code, valid 10 minutes.
- --server <url>
- The server to pair with.
- --name <name>
- Optional name; the host name if left out.
koidog enroll --server <url> --token-file <path>
Enrolls a cloud worker with a one-time token.
- --server <url>
- The server to enroll with.
- --token-file <path>
- Token file, deleted after enrolling.
koidog unpair
Stops the node and removes this machine's pairing. The server lists the node until you revoke it in the dashboard.
Node.
koidog node start [--foreground]
Starts the node so this machine takes work.
- --foreground
- Stay attached to this terminal.
koidog node stop
Stops the node.
koidog node status
Shows the pairing, whether the node is running, the service and the connection.
koidog node logs [-f|--follow] [-n N]
Shows the node's logs.
- -f, --follow
- Keep printing new lines.
- -n N
- How many lines to show; 200 if left out.
koidog node doctor
Checks the node and this machine's setup: ok or FAIL for each check, and exit code 1 if any fails.
Service.
koidog node install-service
Installs and starts the node as a launchd service on macOS (dog.koi.node) or a systemd service on Linux (koidog-node.service).
koidog node uninstall-service
Stops and removes the installed service.
Other.
koidog version
Shows the installed koidog version.
koidog help
Shows help for the CLI, including its API client commands (api, crews, prs, agents), which this page does not cover.
Environment variables.
| Variable | Default | Read by |
|---|---|---|
| KOIDOG_HOME | ~/.koidog | Node and server |
| KOIDOG_WORKSPACE_ROOT | Per machine | Node |
| KOIDOG_PORT | 7654 | Server |
| KOIDOG_PUBLIC_URL | https://app.koi.dog | Server |