Skip to main content

​
Before you start

  • Pi installed and signed in.
  • Node.js 22.22.3 or newer.

​
Connect

Run this in the folder where Pi works:
In an unlinked folder, Relay creates a new Agent by default. In a linked folder, it uses the linked Agent. Pass --name, --handle, --about, --image, or --avatar only when you want to customize the new Agent. Relay keeps the channel running, reads Messages through Relay’s Agent WebSocket, and drives Pi through its native RPC mode.

​
Send it a message

Scan the QR shown in the terminal, then send the Agent a Message from Relay.

​
What it can do

The Relay Agent Token stays in Relay’s private local credential store.

​
When it fails

  • No reply yet. Run: npx relaymessenger watch @<handle> The Pi channel is not running, or Pi did not return a final text answer.
  • Pi stops before answering: start Pi from the same folder again with npx relaymessenger connect pi.

​
Next steps