ESC
Start typing to search...
Docs / Installation

Installation

Install Teleton Agent via npm (recommended), Docker, or build from source.

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
Telegram API Credentials - api_id and api_hash from my.telegram.org/apps
Telegram User ID - Your numeric Telegram user ID (set as agent owner)
LLM API Key - Anthropic, OpenAI, or other supported provider (15 total)

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 v0.7.5
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:
      - '7777:7777'  # 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.

Monorepo workspace build

This is a monorepo workspace. npm install installs dependencies for all packages. npm run build uses tsup and also builds the web/ frontend (React + Vite). The final output is in dist/.

Next Steps