ContextQMD
Back to Eliza

Tlon Connector

packages/docs/connectors/tlon.md

2.0.12.8 KB
Original Source

Tlon Connector

Connect your agent to the Urbit network via Tlon for ship-to-ship messaging using the @elizaos/plugin-tlon package.

Prerequisites

The Tlon connector is an elizaOS plugin that bridges your agent to the Urbit network. It supports ship-to-ship messaging and group chat participation. This connector is available from the plugin registry.

Package Info

FieldValue
Package@elizaos/plugin-tlon
Config keyconnectors.tlon
Installeliza plugins install @elizaos/plugin-tlon

Setup

1. Get Your Urbit Ship Credentials

  1. Have a running Urbit ship (planet, star, or comet)
  2. Note the ship name (e.g., ~zod)
  3. Obtain the access code from your ship's web interface (Settings → Access Key)
  4. Note the ship's URL (e.g., http://localhost:8080)

2. Configure Eliza

NameRequiredDescription
TLON_SHIPNoUrbit ship name (e.g., ~zod)
TLON_CODENoShip authentication/access code
TLON_URLNoShip URL (e.g., http://localhost:8080)
TLON_ENABLEDNoEnable or disable the connector
TLON_DM_ALLOWLISTNoComma-separated allowed user list for DMs
TLON_GROUP_CHANNELSNoComma-separated list of group channel identifiers
TLON_AUTO_DISCOVER_CHANNELSNoAuto-discover available channels (boolean)

Install the plugin from the registry:

bash
eliza plugins install tlon

Configure in ~/.eliza/eliza.json:

json
{
  "connectors": {
    "tlon": {
      "ship": "~zod",
      "code": "YOUR_ACCESS_CODE",
      "url": "http://localhost:8080"
    }
  }
}

Or via environment variables:

bash
export TLON_SHIP=~zod
export TLON_CODE=YOUR_ACCESS_CODE
export TLON_URL=http://localhost:8080

Environment Variables

VariableRequiredDescription
TLON_SHIPYesUrbit ship name (e.g., ~zod)
TLON_CODEYesShip access code
TLON_URLYesShip URL (e.g., http://localhost:8080)
TLON_ENABLEDNoSet to true to enable
TLON_DM_ALLOWLISTNoComma-separated allowed user list for DMs
TLON_GROUP_CHANNELSNoComma-separated list of group channel identifiers
TLON_AUTO_DISCOVER_CHANNELSNoComma-separated list of channels to auto-discover

Configuration Reference

FieldRequiredDescription
shipYesUrbit ship name (e.g., ~zod)
codeYesUrbit ship access code
urlYesUrbit ship URL
enabledNoSet false to disable (default: true)

Features

  • Ship-to-ship messaging on the Urbit network
  • Group chat participation
  • DM allowlist for access control
  • Auto-discovery of group channels