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
Что это такое?takopi — это мост для Telegram, позволяющий управлять агентами для кодинга (Codex, Claude Code, OpenCode или Pi) из чата Telegram: вести несколько репозиториев и git worktree, транслировать прогресс и возобновлять сессии откуда угодно.
takopi сам является агентом или он стоит между Telegram и моим агентом для кодинга?Это self-hosted мост/бот, который вы запускаете на своей машине и который направляет сообщения Telegram в уже существующий движок кодинга (codex, claude, opencode или pi), работающий локально, — сам он агентом не является.
Как его запустить?Установите uv, запустите takopi и следуйте мастеру настройки: создайте токен бота через @BotFather, выберите воркфлоу (assistant, workspace или handoff), подключите свой чат и выберите движок по умолчанию.
Что должно быть установлено перед запуском takopi?Нужны uv для установки, Python 3.14+ и хотя бы один движок кодинга в PATH — codex, claude, opencode или pi — плюс существующая подписка Anthropic или OpenAI для этого движка.
Как работает возобновление сессии и есть ли подвох?Возобновление не хранит состояние: вы либо продолжаете отвечать в чате Telegram, либо копируете выведенную строку возобновления и вставляете её в свой терминал, чтобы подхватить ту же сессию там.
Работает ли он на Linux, macOS и Windows?Да, как Python-CLI, устанавливаемый через uv, он работает кроссплатформенно на Linux, macOS и Windows.
В чём разница между воркфлоу assistant, workspace и handoff?Assistant — это постоянный чат с авто-возобновлением (рекомендуется), workspace привязывает топики форума к конкретным репозиториям/веткам, а handoff позволяет отвечать для продолжения, выводя строки возобновления терминала, чтобы подхватить работу локально.
Как работают worktree в чате?Упоминание имени ветки вроде /happy-gadgets @feat/memory-box поднимает отдельный git worktree для этой ветки, так что вы можете запускать параллельные сессии агентов на разных ветках одного репозитория без конфликтов.
Можно расширить takopi своими движками или командами?Да, takopi поддерживает плагины на основе entrypoint для добавления новых движков, транспортов и команд, что задокументировано в docs/how-to/write-a-plugin.md.
Можно отправлять файлы в репозиторий и из него через Telegram?Да, takopi поддерживает передачу файлов — можно отправлять файлы в репозиторий или забирать файлы и каталоги обратно через чат.
Creator
banteg
Size
1.6 MB
Stars
1.1K
Age
9mo
Commits · 90 Days