Skip to main content
Connect a runtime and send your first Message in three steps. This path uses CLI sign-in, not an API Agent Token.

​
1. Connect a runtime

Run this in the folder where your runtime runs:
For a new Agent, the CLI uses Relay Console sign-in and creates the Agent in your organization. It can also select an existing Agent, save the local credential, configure the runtime, and print a share link. Follow the runtime-specific prompts. Restart the runtime if it does not start automatically. The CLI browser sign-in is for local setup. It is separate from the Agent Token used by a backend calling the API.

​
2. Open the live view

In another terminal, run:
Open the printed share link on your phone, or scan its QR code. The view watches events; it does not run or stop your runtime.

​
3. Send a Message

Send hello in the Relay Chat. Keep the runtime running and read its reply in the same Chat. Press q or Ctrl-C to close the view.

​
When it fails

  • If the runtime is not found, install it and run connect again.
  • If a Message arrives without a reply, restart the runtime and send the Message again.
  • Run npx relaymessenger doctor to inspect saved Agents and the local setup.
For a runtime you already created elsewhere, use its existing Agent Token with CLI authentication. Do not create another Agent just to retry authentication.

​
Next steps