Skip to main content

Codex Telegram + Web

A bridge that lets you control the Codex App Server from Telegram and Web UI.

Features

Telegram Bot

Control Codex directly from Telegram:

  • Slash commands: /start, /resume, /projects, /review, /exec, and more
  • Real-time updates: Receive progress notifications and turn completions
  • Interactive approvals: Approve/deny dangerous operations with inline buttons
  • Multi-project support: Switch between projects with /project <name>
  • Thread management: Start, resume, fork, archive conversations

Web UI

ChatGPT-style interface with advanced features:

  • Streaming responses: Real-time message streaming via SSE
  • Multi-project tabs: Each project has independent workspace context
  • Thread tabs: Multiple conversations per project
  • Workspace browser: File tree, Git status, file preview, diff viewer
  • Settings panels: Features, Models, Modes, Skills, Apps, MCP, Guardian
  • Dark/Light theme: Theme toggle with localStorage persistence
  • Responsive design: Desktop and mobile layouts

Shared Features

  • Approval workflow: Interactive approve/deny for sensitive operations
  • Guardian: Policy-based safety rules to auto-approve or escalate requests
  • Real-time events: Live updates via SSE (Web) and push notifications (Telegram)
  • Multi-project: Manage multiple projects with separate thread histories

Requirements

  • Python 3.11+
  • Telegram Bot Token (if Telegram enabled)
  • Installed and runnable codex CLI
  • Web UI: password and allowed users configured

Find your Telegram user ID: https://t.me/userinfobot

Quick Start

1. Install

pip install codex-telegram

If installation fails, try:

# Upgrade pip first
pip install --upgrade pip

# Install with system packages flag (some Linux distributions)
pip install codex-telegram --break-system-packages

# Or install for current user only
pip install codex-telegram --user

# Or use a virtual environment
python -m venv .venv && source .venv/bin/activate
pip install codex-telegram

Update

The CLI checks for updates automatically on startup. When a newer version is available on PyPI, you'll see:

✨ Update available! 0.5.1 -> 0.5.2

  Release notes: https://github.com/heungtae/codex-telegram/releases/latest

  1. Update now and exit (runs `pip install -U codex-telegram`)
  2. Skip this run
  3. Skip this version

  Choose [1/2/3] (default: 2):

You can also update manually:

pip install -U codex-telegram

Or with system packages flag:

pip install -U codex-telegram --break-system-packages

2. Configure

Create ~/.config/codex-telegram/conf.toml:

project = "default"

[projects.default]
name = "my project"
path = "/path/to/your/project"

[telegram.bot]
token = "YOUR_TELEGRAM_BOT_TOKEN"

[users]
allowed_ids = [123456789]

3. Run

codex-telegram

Or with environment variables:

export TELEGRAM_BOT_TOKEN="your_token"
export CODEX_WEB_PASSWORD="your_password"
codex-telegram

If you want to rebuild the web UI before launching the app, use:

./run_build_and_main.sh

Or:

make run

4. Open Web UI

http://127.0.0.1:8080

Developing from Source

git clone https://github.com/heungtae/codex-telegram.git
cd codex-telegram
pip install -e .
cd web/frontend && npm install && npm run build && cd ../..
cp conf.toml.example ~/.config/codex-telegram/conf.toml
# Edit config, then run:
./run_build_and_main.sh

Documentation

File Description
TELEGRAM.md Telegram bot commands, real-time updates, approval workflow
WEB.md Web UI features, API endpoints, workspace browser
conf.toml.example Full configuration reference

Security

  • Keep users.allowed_ids populated with trusted Telegram user IDs only
  • Use environment variables for tokens: TELEGRAM_BOT_TOKEN, CODEX_WEB_PASSWORD
  • Run one polling instance per bot token to avoid conflicts
  • Set cookie_secure = true when using HTTPS

License

Apache License 2.0. See LICENSE for details.

Release files for codex-telegram 0.5.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for codex-telegram 0.5.5
File Size Uploaded
codex_telegram-0.5.5.tar.gz 326.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for codex-telegram 0.5.5
File Interpreter ABI Platform
codex_telegram-0.5.5-py3-none-any.whl Python 3 none any Details

Total release size: 628.8 kB

Release files / codex_telegram-0.5.5.tar.gz

Download URL codex_telegram-0.5.5.tar.gz
Size 326.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e91483665c2ed8856d36942fa15bbc3b85a1862f1c4d5514ae98d674f4fc35c5
BLAKE2b-256 checksum
How to use checksums
2f1b73df2326f7815b219a78d9029a657bbe6d86df46547cd4418ebbd538887c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / codex_telegram-0.5.5-py3-none-any.whl

Download URL codex_telegram-0.5.5-py3-none-any.whl
Size 302.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1c0f6a708c7470aff29d663ea2abdc5d69190c2889d982bd52f1c4899ba378b4
BLAKE2b-256 checksum
How to use checksums
5084f3add4e140414eeb14fb1c990ed019e8356628ef397d8fa03e811625a894
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release history Release notifications | RSS feed

0.5.9

2 release files

0.5.8

2 release files

0.5.7

2 release files

0.5.6

2 release files

This release

0.5.5 This release

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.15

2 release files

0.4.14

2 release files

0.4.13

2 release files

0.4.12

2 release files

0.4.11

2 release files

0.4.10

2 release files

0.4.9

2 release files

0.4.8

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page