Installation - Teleton Agent Documentation

Requirements

Requirement	Version	Notes
Node.js	`20.x` or higher	LTS recommended
npm	`10.x` or higher	Comes with Node.js
Telegram Account	-	Phone number required for MTProto auth
LLM API Key	-	Anthropic, OpenAI, or other provider

Option 1: npm (Recommended)

The easiest way to install Teleton is via npm:

Terminal

npm install -g teleton@latest

Verify the installation:

Terminal

teleton --version
# Output: teleton v1.x.x

First-time setup

After installation, run teleton setup to configure your agent interactively.

Option 2: Docker

Run Teleton in a Docker container for isolated deployment:

Terminal

# Pull the image
docker pull ghcr.io/tonresistor/teleton-agent:latest

# Run with mounted config
docker run -d \
  --name teleton \
  -v ~/.teleton:/root/.teleton \
  ghcr.io/tonresistor/teleton-agent:latest

Docker Compose

For easier management, use Docker Compose:

docker-compose.yml

version: '3.8'

services:
  teleton:
    image: ghcr.io/tonresistor/teleton-agent:latest
    container_name: teleton
    restart: unless-stopped
    volumes:
      - ./data:/root/.teleton
    environment:
      - ANTHROPIC_API_KEY=${ANTHROPIC_API_KEY}
    ports:
      - '3000:3000'  # WebUI

Option 3: Build from Source

For development or customization, build from source:

Terminal

# Clone the repository
git clone https://github.com/TONresistor/teleton-agent.git
cd teleton-agent

# Install dependencies
npm install

# Build
npm run build

# Link globally (optional)
npm link

Native dependencies

Building from source requires native compilation tools for better-sqlite3. On Ubuntu/Debian, run sudo apt install build-essential python3.

Next Steps

Configuration: set up your config.yaml and connect to Telegram
Quick Start: get your agent running in 5 minutes