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 桥接器,让你在 Telegram 聊天中控制编程智能体(Codex、Claude Code、OpenCode 或 Pi),管理多个仓库和 git worktree,流式呈现进度,并随处恢复会话。
takopi 本身是智能体,还是位于 Telegram 和我的编程智能体之间?它是你在自己机器上运行的自托管桥接器/机器人,把 Telegram 消息路由到本地运行的既有编程引擎(codex、claude、opencode 或 pi)——它本身不运行智能体。
我怎么让它跑起来?安装 uv,运行 takopi,然后跟随设置向导:通过 @BotFather 创建机器人令牌,选择一种工作流(assistant、workspace 或 handoff),连接你的聊天,并选择默认引擎。
运行 takopi 之前我需要安装什么?你需要用于安装的 uv、Python 3.14+,以及 PATH 中至少一个编程引擎——codex、claude、opencode 或 pi——外加该引擎对应的现有 Anthropic 或 OpenAI 订阅。
恢复会话是怎么工作的?有没有什么限制?恢复是无状态的:你要么继续在 Telegram 聊天中回复以延续会话,要么复制打印出来的 resume 行并粘贴到终端,在那里接着同一个会话。
它能在 Linux、macOS 和 Windows 上运行吗?可以。作为通过 uv 安装的 Python CLI,它在 Linux、macOS 和 Windows 上跨平台运行。
assistant、workspace 和 handoff 三种工作流有什么区别?assistant 是带自动恢复的持续聊天(推荐),workspace 把论坛话题映射到特定的仓库/分支,handoff 则让你通过回复继续,同时打印终端 resume 行以便在本地接续工作。
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