takopi README

The project's README from github.com/banteg/takopi. As one markdown file: README.md.

takopi

🐙 he just wants to help-pi

telegram bridge for codex, claude code, opencode, pi. manage multiple projects and worktrees, stream progress, and resume sessions anywhere.

features

requirements

uv for installation (curl -LsSf https://astral.sh/uv/install.sh | sh)

python 3.14+ (uv python install 3.14)

at least one engine on PATH: codex, claude, opencode, or pi

install

uv tool install -U takopi

setup

run takopi and follow the setup wizard. it will help you:

  1. create a bot token via @BotFather
  2. pick a workflow (assistant, workspace, or handoff)
  3. connect your chat
  4. choose a default engine

workflows configure conversation mode, topics, and resume lines automatically:

usage

cd ~/dev/happy-gadgets
takopi

send a message to your bot. prefix with /codex, /claude, /opencode, or /pi to pick an engine. reply to continue a thread.

register a project with takopi init happy-gadgets, then target it from anywhere with /happy-gadgets hard reset the timeline.

mention a branch to run an agent in a dedicated worktree /happy-gadgets @feat/memory-box freeze artifacts forever.

inspect or update settings with takopi config list, takopi config get, and takopi config set.

see takopi.dev for configuration, worktrees, topics, file transfer, and more.

plugins

takopi supports entrypoint-based plugins for engines, transports, and commands.

see docs/how-to/write-a-plugin.md and docs/reference/plugin-api.md.

development

see docs/reference/specification.md and docs/developing.md.

takopi (banteg/takopi)

Searching Database…

1.1K ·GitHub
What is this?takopi is a Telegram bridge that lets you control coding agents (Codex, Claude Code, OpenCode, or Pi) from a Telegram chat, managing multiple repos and git worktrees, streaming progress, and resuming sessions anywhere.
Is takopi an agent itself, or does it sit between Telegram and my coding agent?It's a self-hosted bridge/bot you run on your own machine that routes Telegram messages to an existing coding engine (codex, claude, opencode, or pi) running locally — it doesn't run an agent itself.
How do I get it running?Install uv, run takopi, and follow the setup wizard: create a bot token via @BotFather, pick a workflow (assistant, workspace, or handoff), connect your chat, and choose a default engine.
What do I need installed before running takopi?You need uv for installation, Python 3.14+, and at least one coding engine on PATH — codex, claude, opencode, or pi — plus an existing Anthropic or OpenAI subscription for that engine.
How does resuming a session work, and is there a catch?Resume is stateless: you either keep replying in the Telegram chat to continue, or copy the printed resume line and paste it into your terminal to pick the same session back up there.
Does it run on Linux, macOS, and Windows?Yes, as a Python CLI installed via uv it runs cross-platform on Linux, macOS, and Windows.
What's the difference between the assistant, workspace, and handoff workflows?Assistant is an ongoing chat with auto-resume (recommended), workspace maps forum topics to specific repos/branches, and handoff lets you reply to continue while printing terminal resume lines for picking work up locally.
How do worktrees work in a chat?Mentioning a branch name like /happy-gadgets @feat/memory-box spins up a dedicated git worktree for that branch, so you can run parallel agent sessions on different branches of the same repo without them colliding.
Can I extend takopi with custom engines or commands?Yes, takopi supports entrypoint-based plugins for adding new engines, transports, and commands, documented in docs/how-to/write-a-plugin.md.
Can I send files to and from the repo through Telegram?Yes, takopi supports file transfer — you can send files into the repo or fetch files and directories back out through the chat.
Creator
banteg
Size
1.6 MB
Stars
1.1K
Age
9mo
Commits · 90 Days