Pair a Mac.

One code, one command, and your Mac becomes a node.

Before you start.

  • A Mac with a terminal and the koidog command on it.
  • A sign-in for app.koi.dog.

Step 1 of 4

Get a pairing code.

In app.koi.dog, open Machines and choose Pair a machine. It shows a one-time command with an 8-character code, valid for 10 minutes.

Step 2 of 4

Run the pairing command.

Paste the dashboard's command into a terminal on the Mac.

Terminal
# once koidog is on the machine
$ koidog pair <code> --server https://app.koi.dog
# or choose the node's name
$ koidog pair <code> --server https://app.koi.dog --name <name>

Step 3 of 4

Start the node.

The Mac takes work only while the node runs.

Terminal
# once koidog is on the machine
$ koidog node start
# or install it as a launchd service
$ koidog node install-service

Step 4 of 4

Check that it works.

Run these on the Mac.

koidog node status
Pairing, daemon, service, connection.
koidog node doctor
ok or FAIL for each setup check.
koidog node logs -f
Node logs; -f follows them.

Where the node keeps things.

VariableDefaultWhat it is
KOIDOG_HOME~/.koidogWhere Koidog keeps its state.
KOIDOG_WORKSPACE_ROOT~/.koidog/workspacesRoot folder for agent workspaces.

Unpair.

Run koidog unpair on the Mac to stop the node and forget its pairing.