izackp/takopi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: rework readme

Browse Source
This commit is contained in:
banteg
2026-01-12 04:14:58 +04:00
parent e8c478d786
commit a1090bdf83
1 changed files with 24 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+24 -144
View File
@@ -2,29 +2,18 @@
🐙 *he just wants to help-pi* 🐙 *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. telegram bridge for codex, claude code, opencode, pi. manage multiple projects and worktrees, stream progress, and resume sessions anywhere.
## features ## features
projects and worktrees: register repos with `takopi init`, target them via `/project`, route to branches with `@branch`. - projects and worktrees: work on multiple repos/branches simultaneously, branches are git worktrees
- stateless resume: continue in chat or copy the resume line to pick up in terminal
stateless resume: continue a thread in the chat or pick up in the terminal. - progress streaming: commands, tools, file changes, elapsed time
- parallel runs across agent sessions, per-agent-session queue
progress updates while agent runs (commands, tools, notes, file changes, elapsed time). - works with telegram features like voice notes and scheduled messages
- file transfer: send files to the repo or fetch files/dirs back
robust markdown rendering of output with a lot of quality of life tweaks. - group chats and topics: map group topics to repo/branch contexts
- works with existing anthropic and openai subscriptions
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 ## requirements
@@ -32,152 +21,43 @@ per-project chat routing: assign different telegram chats to different projects.
python 3.14+ (`uv python install 3.14`) python 3.14+ (`uv python install 3.14`)
at least one engine on PATH: at least one engine on PATH: `codex`, `claude`, `opencode`, or `pi`
`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 ## install
`uv tool install -U takopi` ```sh
uv tool install -U takopi
```
## setup ## 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. run `takopi` and follow the instructions. it will help you create a bot token, set up the default chat, and set the 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 ## usage
start takopi in the repo you want to work on:
```sh ```sh
cd ~/dev/your-repo cd ~/dev/happy-gadgets
takopi 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: send a message to your bot. prefix with `/codex`, `/claude`, `/opencode`, or `/pi` to pick an engine. reply to continue a thread.
```sh register a project with `takopi init happy-gadgets`, then target it from anywhere with `/happy-gadgets hard reset the timeline`.
takopi plugins
takopi --transport telegram
```
resume lines always route to the matching engine; subcommands only override the default for new threads. mention a branch to run an agent in a dedicated worktree `/happy-gadgets @feat/memory-box freeze artifacts forever`.
send a message to the bot. see [`docs/user-guide.md`](docs/user-guide.md) for configuration, worktrees, topics, file transfer, and more.
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 ## plugins
takopi supports entrypoint-based plugins for engines, transports, and command backends. takopi supports entrypoint-based plugins for engines, transports, and commands.
see [`docs/plugins.md`](docs/plugins.md) and [`docs/public-api.md`](docs/public-api.md). see [`docs/plugins.md`](docs/plugins.md) and [`docs/public-api.md`](docs/public-api.md).
## development ## development
see [`docs/specification.md`](docs/specification.md) and [`docs/developing.md`](docs/developing.md). see [`docs/specification.md`](docs/specification.md) and [`docs/developing.md`](docs/developing.md).
## community
[takopi dev](https://t.me/+jFvQTLE8m183MjBi) telegram group