# takopi

🐙 *he just wants to help-pi*

telegram bridge for codex, claude code, opencode, pi, and [other agents](docs/adding-a-runner.md). manage multiple projects and worktrees, stream progress, and resume sessions anywhere.

## features

projects and worktrees: register repos with `takopi init`, target them via `/project`, route to branches with `@branch`.

stateless resume: continue a thread in the chat or pick up in the terminal.

progress updates while agent runs (commands, tools, notes, file changes, elapsed time).

robust markdown rendering of output with a lot of quality of life tweaks.

parallel runs across threads, per thread queue support.

`/cancel` a running task.

optional voice note transcription for telegram (routes transcript like typed text).

telegram file transfer: upload documents into repos (`/file put`) and fetch files back (`/file get`).

telegram forum topics: bind a topic to a project/branch and keep per-topic session resumes.

per-project chat routing: assign different telegram chats to different projects.

## 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` (`npm install -g @openai/codex` or `brew install codex`)

`claude` (`npm install -g @anthropic-ai/claude-code`)

`opencode` (`npm install -g opencode-ai@latest`)

`pi` (`npm install -g @mariozechner/pi-coding-agent`)

## install

`uv tool install -U takopi`

## setup

run `takopi` and follow the interactive prompts. it will help you create a bot token (via [@BotFather](https://t.me/BotFather)), capture your `chat_id` from the most recent message you send to the bot, and set a default engine.

to re-run onboarding (and overwrite config), use `takopi --onboard`.

run your agent cli once interactively in the repo to trust the directory.

see [`docs/user-guide.md`](docs/user-guide.md) for detailed configuration and usage.

## config

global config `~/.takopi/takopi.toml`

```toml
default_engine = "codex"
# optional: reload config changes without restarting
watch_config = true

# optional, defaults to "telegram"
transport = "telegram"

[transports.telegram]
bot_token = "123456789:ABCdefGHIjklMNOpqrsTUVwxyz"
chat_id = 123456789
voice_transcription = true

[transports.telegram.files]
enabled = true
auto_put = true
allowed_user_ids = [123456789]

[transports.telegram.topics]
enabled = true

[codex]
# optional: profile from ~/.codex/config.toml
profile = "takopi"
# optional: extra codex CLI args (exec flags are managed by Takopi)
# extra_args = ["-c", "notify=[]"]

[claude]
model = "sonnet"
# optional: defaults to ["Bash", "Read", "Edit", "Write"]
allowed_tools = ["Bash", "Read", "Edit", "Write", "WebSearch"]
dangerously_skip_permissions = false
# uses subscription by default, override to use api billing
use_api_billing = false

[opencode]
model = "claude-sonnet-4-20250514"

[pi]
model = "gpt-4.1"
provider = "openai"
# optional: additional CLI arguments
extra_args = ["--no-color"]
```

note: configs with top-level `bot_token` / `chat_id` are migrated to `[transports.telegram]` on startup.
note: `watch_config` reloads runtime settings (projects, engines, plugins). transport changes still require a restart.

## projects

register the current repo as a project alias:

```sh
takopi init z80
```

`takopi init` writes the repo root to `[projects.<alias>].path`. if you run it inside a git worktree, it resolves the main checkout and records that path instead of the worktree.

example:

```toml
default_project = "z80"

[projects.z80]
path = "~/dev/z80"
worktrees_dir = ".worktrees"
default_engine = "codex"
worktree_base = "master"
chat_id = -123456789
```

set `chat_id` to route messages from that chat to the project automatically.

note: the default `worktrees_dir` lives inside the repo, so `.worktrees/` will
show up as untracked unless you ignore it (add to `.gitignore` or
`.git/info/exclude`), or set `worktrees_dir` to a path outside the repo.

## usage

start takopi in the repo you want to work on:

```sh
cd ~/dev/your-repo
takopi
# or override the default engine for new threads:
takopi claude
takopi opencode
takopi pi
```

list available plugins (engines/transports/commands), and override in a run:

```sh
takopi plugins
takopi --transport telegram
```

resume lines always route to the matching engine; subcommands only override the default for new threads.

send a message to the bot.

start a new thread with a specific engine by prefixing your message with `/codex`, `/claude`, `/opencode`, or `/pi`.

to continue a thread, reply to a bot message containing a resume line.
you can also copy it to resume an interactive session in your terminal.

to stop a run, reply to the progress message with `/cancel`.

default: progress is silent, final answer is sent as a new message so you receive a notification, progress message is deleted.

if you prefer no notifications, `--no-final-notify` edits the progress message into the final answer.

## plugins

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

see [`docs/plugins.md`](docs/plugins.md) and [`docs/public-api.md`](docs/public-api.md).

## development

see [`docs/specification.md`](docs/specification.md) and [`docs/developing.md`](docs/developing.md).