Back to Eliza

Tlon Plugin

packages/docs/plugin-registry/platform/tlon.md

2.0.11.9 KB
Original Source

The Tlon plugin connects Eliza agents to Tlon (Urbit), enabling message handling through a connected Urbit ship.

Package: @elizaos/plugin-tlon

Installation

bash
eliza 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

json
{
  "connectors": {
    "tlon": {
      "ship": "YOUR_SHIP",
      "code": "YOUR_CODE",
      "url": "YOUR_URL"
    }
  }
}

Or via environment variables:

bash
export TLON_SHIP=YOUR_SHIP
export TLON_CODE=YOUR_CODE
export TLON_URL=YOUR_URL

Configuration

FieldRequiredDescription
shipYesUrbit ship name (e.g., ~zod)
codeYesUrbit ship access code
urlYesUrbit ship URL
enabledNoSet false to disable (default: true)
dmAllowlistNoComma-separated allowed user list for DMs
groupChannelsNoComma-separated list of group channel identifiers
autoDiscoverChannelsNoComma-separated list of channels to auto-discover

Environment Variables

VariableRequiredDescription
TLON_SHIPNoUrbit ship name (e.g., ~zod)
TLON_CODENoUrbit ship access code
TLON_URLNoUrbit ship URL
TLON_ENABLEDNoEnable or disable the connector
TLON_DM_ALLOWLISTNoComma-separated allowed ship names for DMs
TLON_GROUP_CHANNELSNoComma-separated group channel paths
TLON_AUTO_DISCOVER_CHANNELSNoAuto-discover channels from groups