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

docs: clean up readme

Browse Source 
- add per-project chat routing to features
- fix inactive doc links in plugins section
- remove redundant python install step
- remove notes section (locks handle single-instance)
- explain chat_id in projects section
This commit is contained in:
banteg
2026-01-10 01:39:40 +04:00
parent 1b74d0ab54
commit c2c4190881
1 changed files with 6 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+6 -13
View File
@@ -20,6 +20,8 @@ parallel runs across threads, per thread queue support.
optional voice note transcription for telegram (routes transcript like typed text). optional voice note transcription for telegram (routes transcript like typed text).
per-project chat routing: assign different telegram chats to different projects.
## requirements ## requirements
- `uv` for installation (`curl -LsSf https://astral.sh/uv/install.sh | sh`) - `uv` for installation (`curl -LsSf https://astral.sh/uv/install.sh | sh`)
@@ -32,7 +34,6 @@ optional voice note transcription for telegram (routes transcript like typed tex
## install ## install
- `uv python install 3.14`
- `uv tool install -U takopi` to install as `takopi` - `uv tool install -U takopi` to install as `takopi`
- or try it with `uvx takopi@latest` - or try it with `uvx takopi@latest`
@@ -63,8 +64,6 @@ bot_token = "123456789:ABCdefGHIjklMNOpqrsTUVwxyz"
chat_id = 123456789 chat_id = 123456789
voice_transcription = true voice_transcription = true
# set OPENAI_API_KEY in your environment for voice transcription
[codex] [codex]
# optional: profile from ~/.codex/config.toml # optional: profile from ~/.codex/config.toml
profile = "takopi" profile = "takopi"
@@ -111,9 +110,11 @@ path = "~/dev/z80"
worktrees_dir = ".worktrees" worktrees_dir = ".worktrees"
default_engine = "codex" default_engine = "codex"
worktree_base = "master" worktree_base = "master"
chat_id = -123456789 # optional, project chat id 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 note: the default `worktrees_dir` lives inside the repo, so `.worktrees/` will
show up as untracked unless you ignore it (add to `.gitignore` or 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. `.git/info/exclude`), or set `worktrees_dir` to a path outside the repo.
@@ -157,15 +158,7 @@ if you prefer no notifications, `--no-final-notify` edits the progress message i
takopi supports entrypoint-based plugins for engines, transports, and command backends. takopi supports entrypoint-based plugins for engines, transports, and command backends.
see: see [`docs/plugins.md`](docs/plugins.md) and [`docs/public-api.md`](docs/public-api.md).
- `docs/plugins.md`
- `docs/public-api.md`
## notes
* the bot only responds to the primary `chat_id` plus any per-project `chat_id`
* run only one takopi instance per bot token: multiple instances will race telegram's `getUpdates` offsets and cause missed updates
## development ## development