formerly TelegramCode
Telegram bot/group as a terminal for OpenCode, Claude Code — every thread like a terminal tab + scheduling, voice control
Charness turns Telegram into a terminal for running agentic CLIs. Open as many tabs as you need — even two on the same project for parallel work — and drive the agents from your phone or tablet, voice messages included.
Think OpenClaw for vibe coding, driven entirely from Telegram: no complex setup, no extra dashboards — direct access to your own OpenCode / Claude Code running on your machine or server.
- Simple setup & management — install the CLI, put your bot token in one
.env, bind a topic to a folder, and run; everything after is managed from Telegram — no dashboards - Multi-thread / topic — one topic per directory with your agent; two topics can share one folder for parallel work — run almost unlimited agents in parallel
- Two chat surfaces — forum-group topics and the owner's bot DM, both served at once by default, with tabs on either
- Agent backends — OpenCode (native server API over HTTP+SSE) and Claude Code (three backends — json-stream, per-turn and tmux)
- Sleeping agents — a Claude json-stream topic's process is stopped when idle (or after every turn in per-turn mode) and the next message resumes the same conversation by itself, prompt cache still warm
- Raw terminal —
/terminalbinds a topic to a real$SHELLin the project folder - Notifications — when the agent asks a question, the bot pins that message so even a muted topic notifies you: the pin pierces mute, giving exactly one notification per question (unpinned once you answer)
- Scheduled & self-driving runs —
/schedulearms cron / one-shot / N-times jobs per topic, and the agent can schedule itself via injected MCP tools: nightly reviews, recurring reports, a "finish this tomorrow at 9" hand-off. Each job fires as a fresh session with your prompt; restart-safe, with one catch-up for a run missed while the bot was down - Reminders —
/reminderssets a plain reminder with inline buttons (how often, which day, what time, then the text by typing or voice); at the due time the bot posts and pins it itself, so even a muted topic notifies you. No agent, no bound folder, no date parsing — works in any topic, General included - Inbound files — photos / documents / video / audio sent to a topic are saved and announced to the agent; albums arrive as one prompt
- Outbound files — the agent sends files back to you — a generated chart, a screenshot, a log, a rendered PDF — single files or albums, straight into the topic
- Voice input — Whisper transcription via Groq (preferred) or OpenAI
- Display verbosity and view —
/verbosity(plus/thinking,/tool_results,/subagent) per topic: detailminimal|short|full, and what the topic shows —stream(default),stream_answersoranswers(only the agent's pinned answers, no stream) - Time-aware prompts —
/timestamps onprepends each forwarded prompt's send time (local-offset ISO), so a days-long session knows what "yesterday" or "2 days ago" means; agent-facing only, per topic - Reply context — reply to a message in a topic and the quoted text is folded into the prompt the agent receives, so it sees what you point at without re-pasting; works for text, voice and files (a photo, a document, an album…), both agents; a reply TO a photo, file or voice note names it, with the path of the bot's saved copy when it has one
- Your timezone —
/timezone Europe/Moscowonce, and schedules fire at your wall-clock time while the agent is told what time it actually is; no server-clock guessing - Waits out usage limits — when the agent hits a usage / session limit the bot reads the reset time out of the error (honouring the timezone the provider quotes), waits, then tells the agent to continue by itself and pins the "work resumed" message so a muted topic still notifies you;
/limitsturns waiting off per topic or skips a single resume. With a fallback chain (/limits: other Claude accounts, OpenCode providers and models, in your order of preference) the limit notice offers «🔁 Switch to …» buttons to move the topic to the next entry with room and continue at once — or the bot does it by itself when you turn switching on; across backends the new agent gets a context bridge with the previous one's last turns
The bot serves two Telegram surfaces:
- Forum supergroup — every topic is a tab. The most familiar UX: a visible topic list, per-topic names and icons, quick switching between agents. The trade-off is Telegram's group throughput cap (about 20 messages/min per group), so the bot paces and coalesces heavy output streams.
- The bot's own DM (owner only) — the private chat runs in topic mode too, so you get the same thread-per-agent tabs there, and live output streams through Telegram's native draft "cursor": the reply grows in place in one message instead of arriving as a flood of separate messages.
The bot runs anywhere the agent CLIs run:
- Your own working machine — the simplest start: launch
telegramcodefrom your projects parent folder and your laptop/desktop becomes the backend. The catch: agents are only reachable while the machine is on and awake. - A remote server (cloud VPS/VDS or bare metal) — the more convenient
setup: organize your working environment there once (git + your repos,
Claude Code / OpenCode,
telegramcode) and you get an always-on dev box you drive from any device through Telegram — phone, tablet, voice. When picking one, a bare-metal server without virtualization beats a virtualized VPS/VDS: its NVMe drives are usually much faster, which matters once you also build and run a dev server there, not just the agents. Classic terminal access to the very same Claude sessions stays available over SSH — run plainclaudein the project folder: it reads the same~/.claude/projects/<cwd-slug>/session store the bot uses, so a session started in a Telegram thread can be picked up in the terminal and vice versa.
Five steps: install the CLI, create a bot, (optionally) set up a group, launch from your projects folder, bind a topic to an agent.
[manual] tags a step you must do by hand in the Telegram app — an agent running on the host can't do it for you. Everything unmarked is a host-side command (or file edit) that can be automated.
npm install -g charness # needs Node ≥ 22.12This registers the telegramcode command (it keeps the project's former name;
charness works too). Coming from the old telegramcode npm package (2.x)?
Run npm uninstall -g telegramcode first: both install the same commands. The
config, DATA_DIR and sessions carry over as they are.
Prefer the whole bot in a container, isolated from the host? Use Run with Docker instead — the bot and group steps are the same. To hack on the bot itself, see Run from source.
[manual] In Telegram, with @BotFather:
- Message @BotFather, send
/newbot, follow prompts. - Save the token (
123456789:ABCdef...). - Disable privacy mode — same chat:
/setprivacy→ pick this bot →Disable. Without this the bot only sees/commands, not free-form text.
Put the token where the bot reads it — the global config .env:
mkdir -p ~/.config/telegramcode
$EDITOR ~/.config/telegramcode/.env# ~/.config/telegramcode/.env — the one place your keys live
TELEGRAM_BOT_TOKEN=123456789:ABCdef...
# GROQ_API_KEY=... # optional: free voice transcription
# OWNER_USER_ID=... # set to drive the bot from its DM (step 3)All keys the bot needs live in this one file — the bot token and the optional
GROQ_API_KEY for voice sit side by side, no separate stores. (Agent
provider auth is the exception, and lives inside the agents themselves:
claude login for Claude, /connect or OpenCode's own config for OpenCode —
see Environment Variables.) The wrapper loads env
from two locations, in order — a global base and an optional per-project
override:
~/.config/telegramcode/.env— base, set once, used everywhere.$PWD/.env— per-project tweaks (last write wins).
The full annotated template is .env.example (shipped with the package and in
the repo).
The bot serves a forum supergroup, the owner's private chat (DM), or
both at once (CHAT_MODE, default both). The group is the nicest UX — a
visible topic list, per-topic names/icons, quick agent switching — but it is
optional: with OWNER_USER_ID set you can run entirely from the bot's DM.
To use a group (recommended) — [manual], all in the Telegram client:
- In a Telegram client:
New Group→ name it → add the bot. - Open group settings → enable Topics (Forum mode).
- Promote the bot to admin with these rights:
Manage Topics(required — bind/create threads)Delete Messages(for/clear_messages)Pin Messages(per-thread status banner + question alerts;/doctorwarns if missing, but the bot still runs without it)
- Remove the bot from the group and add it again. Telegram caches the privacy-mode flag on join; without re-adding, the bot keeps private-mode and ignores free-form messages (see Troubleshooting → Bot doesn't see text).
The group id is automatic — leave ALLOWED_GROUP_ID empty and the bot
auto-pairs with the first forum supergroup an admin talks to it from (the
-100… id is saved to state.json; re-point later with /pair). To pin a
specific id by hand, set ALLOWED_GROUP_ID to the numeric value (a group
name is not accepted) — that also disables auto-pairing. Access control:
whoever is a creator/administrator of that group may drive the bot — there is no
separate allow-list.
To use the DM instead (or as well): [manual] send /start to
@userinfobot for your numeric user id, then add it
(host-side) to the same .env:
OWNER_USER_ID=987654321With the default CHAT_MODE=both, an unset OWNER_USER_ID just leaves the DM
surface inert (group-only); set it and the DM lights up alongside the group. Use
CHAT_MODE=dm to skip the group entirely.
cd ~/projects && telegramcodeThat $PWD — the parent folder holding your repositories — is the folder the
bot works in; each topic binds to a subfolder under it. There's nothing else to
configure for it. A single-instance lockfile ($DATA_DIR/instance.lock) stops a
second bot starting under the same user; stale locks (after kill -9) are
reclaimed automatically.
This step is [manual] — it all happens inside the Telegram app.
In the group:
- Open the group; in the General topic send
/ls— the bot lists subfolders under the work root. - Create a topic (the
+button). - In the new topic:
/bind <subdir>(auto-bound if the topic name matches a subdir). /claudeor/opencode→ talk to the agent (text or voice).
In the DM: the same commands, one thread per agent — /ls,
/bind <subdir>, then /claude or /opencode.
Then: /quit ends the session; bare /bind inspects/reconfigures the binding;
/clear_messages deletes the topic's bot messages.
Continue the same session from a terminal. No wrapper needed: run
claude --dangerously-skip-permissionsin the project folder. It is the same binary and the same~/.claude/projects/<cwd-slug>/session store the bot uses, so a thread started in Telegram can be picked up withclaude --resumeand vice versa.
The whole bot runs in one container: the bot itself, tmux, every agent it starts (Claude Code in any backend,
/terminal, OpenCode and its server) and the bot's MCP server. Everything works as on a host; the host only
lends the container the folders it mounts, so the bot and its agents see nothing else of the machine.
host container telegramcode-<instance>
your instance env file (tokens) ── ro ──▶ the bot (hot mode) + a restart loop
DATA_DIR, WORK_ROOT ──────▶ tmux, the agents, OpenCode, the bot MCP
a clone of this repository ──────▶ /opt/telegramcode
the agents' home folder ──────▶ /home/telegramcode: their Claude / OpenCode
login, sessions and CLI installs
-
Image and checkout. Clone the repository for the container (a full clone of its own, not a worktree and not the checkout a host instance runs from) and build the image from it:
git clone https://github.com/olosegres/charness /srv/telegramcode/checkout cd /srv/telegramcode/checkout && docker build -t telegramcode -f docker/Dockerfile .
The image holds only system tools (tmux, git, ffmpeg, ripgrep, …) and the yarn the checkout's
package.jsonnames (build from the checkout's root, which is how the build reads it; rebuild after a yarn bump so no container has to download it). On first start the container installs the checkout's dependencies for the image and builds it; the bot installs Claude Code and OpenCode into the agents' home. -
Instance env file, as for a host install (
TELEGRAM_BOT_TOKEN,DATA_DIR,WORK_ROOT, …). It stays on the host and is mounted read-only. Every host path it names (DATA_DIR,WORK_ROOT,TMUX_TMPDIR, …) is mounted at the SAME path, sostate.json, sessions and file paths stay valid inside and an instance can move between host and container unchanged. -
Run (or use
examples/docker-compose.yml):docker run -d --name telegramcode-main --hostname telegramcode-main \ --restart unless-stopped --stop-timeout 60 \ -v /srv/telegramcode/checkout:/opt/telegramcode \ -v /srv/telegramcode/home:/home/telegramcode \ -v /srv/telegramcode/data:/srv/telegramcode/data \ -v /srv/projects:/srv/projects \ -v /srv/telegramcode/instance.env:/srv/telegramcode/instance.env:ro \ -e ENV_FILE=/srv/telegramcode/instance.env \ telegramcode
No port is published: Telegram is long polling, and the bot's MCP server and the OpenCode server listen on the container's own loopback. Keep the
--hostnamefixed and unique per instance: the instance lock tells its own restarted container from another machine by it. -
Log the agents in once, with the account the agents should use (a separate one is best):
docker exec -it telegramcode-main claude, then/login(or/loginin a topic). OpenCode:/connectin a topic, ordocker exec -it telegramcode-main opencode auth login. Never copy your own~/.claudelogin in: a second holder of its refresh token can log the first one out. For git, put a.gitconfigand an SSH key of their own into the agents' home.
Running it:
- Restart the bot only (agents keep running and are adopted):
docker exec telegramcode-main telegramcode-restart-bot. A crashed bot is restarted by the container after 20 s. - Update the bot:
docker exec telegramcode-main /opt/telegramcode/scripts/self-update.sh(by hand or from a timer on the host); hot mode picks the change up. A change tosrc/cli.ts,src/cli/hot.tsornodemon.jsonneeds the bot restart above. Update Claude Code / OpenCode: they update themselves in the agents' home, ordocker exec telegramcode-main npm install -g @anthropic-ai/claude-code/… opencode-ai. - A container restart is a reboot: every agent process ends; each conversation resumes with its next message.
- Rootless Docker (recommended): the container's root is your user, so everything written on the mounts is
yours. Rootful Docker: add
--user "$(id -u):$(id -g)"and give that user the agents' home. - Moving a host instance in: stop it first (the lock refuses a lock written on another host), mount its
folders at their paths, and copy its conversations' folders from
~/.claude/projects/into the agents' home.claude/projects/— without them each conversation starts a fresh session on its next message. - What the agents can read: everything mounted, the instance env file with its tokens,
DATA_DIRand the checkout included. The container keeps the rest of the host out of reach; running the agents as a second user inside the container would close that gap later.
To hack on the bot itself:
git clone https://github.com/olosegres/charness && cd charness
yarn install && yarn build
npm install -g . # registers the `telegramcode` (and `charness`) commandShortcut: yarn install-link runs yarn install && yarn build && npm link in
one shot — npm link symlinks the global telegramcode to this folder, so
later rebuilds (yarn build) are picked up without re-installing. Config and
launch are identical to steps 2–5 above.
Launch telegramcode from the parent folder that holds your project repos —
that $PWD is the work root, and every topic binds to a subfolder under it:
$PWD=/home/user/src ← run the bot here ($PWD = work root)
├── projectA/ ← Topic "projectA" (claude)
├── projectB/ ← Topic "projB-frontend" (claude)
│ ← Topic "projB-backend" (opencode) ← one folder, two topics
│ ← Topic "projB-refactor" (claude)
└── projectC/ ← Topic "projectC" (opencode)
Telegram forum supergroup
├── Bot is admin with can_manage_topics + can_delete_messages + can_pin_messages
└── Routes each topic by (chatId, threadId) → remembered in state.json
What the bot remembers (state.json). So a restart is seamless, the bot
saves which topic is bound to which folder, each topic's live agent session (to
re-attach it after a reboot), your per-topic preferences (agent, model,
reasoning effort, language, display verbosity), scheduled prompts, and the
paired group id. This file lives in DATA_DIR (default ~/.telegramCode) and
is written safely, so a crash can't corrupt it.
Most commands work in any topic; a binding (/bind) is required only to
actually start an agent or terminal in the folder.
| Command | Description |
|---|---|
/claude, /opencode, /oc |
Start agent in this topic's bound folder |
/terminal |
Open a raw $SHELL in the bound folder — see Raw terminal |
/claude_mode |
Switch this topic's Claude backend (json-stream ⇄ per-turn ⇄ tmux-scrape); bare shows a picker — see Claude Code backends |
/model |
Switch model through a two-level picker: providers, then that provider's models (10 per page). On OpenCode the first row is 🕘 Recently used — a flat list of the models picked before, across providers (bot-wide, most recent first, up to 10), one tap to switch; it appears once something has been picked. Each provider row has a 🙈 to hide it from the picker (bot-wide, persisted; 👁 brings it back) — /model <provider/model> still reaches a hidden provider. If OpenCode is waiting on an old provider's retry, the next prompt interrupts that wait and starts with the selected model instead of sitting queued behind it |
/accounts |
Every account the bot works with, on one screen. Claude accounts (when you keep several subscriptions signed in): each profile with its email, plan (personal Pro/Max or corporate Team/Enterprise), how many topics use it and its usage windows, ✓ on the active one; tap a profile to switch this topic (a running session is restarted under it, same conversation — at the end of its turn if it is working); in General the pick becomes the default for all topics. Per profile: 🔑 signs it in again, 🗑 removes it (after a confirmation; for default, which IS ~/.claude, «remove» signs it out — see below). The usage lines give each window's percentage USED and when it resets as a time from now (5h 5% 🔄 in 4h · week 20% 🔄 in 5d 8h · Fable 4% 🔄 in 5d 8h; «🔄 in 2h», «🔄 in 2d 1h», «🔄 in 30m»; Fable only on a plan that has its own weekly window); when the 5h window's reset is unknown the weekly one is shown in its place, and with no reset at all only the percentage. The hint paragraph under the account list says the percentages are used. «➕ Claude account» asks for a name and runs the sign-in. OpenCode providers: the connected ones are listed with a «🔌 Disconnect » button and a 🔑 (connect again) each (the disconnect asks, then removes the stored credentials; a provider OpenCode enables from an environment variable, e.g. OPENROUTER_API_KEY, stays active — the reply says so and points at hiding it in /model); «➕ OpenCode provider» asks for the provider id and continues with the connect flow (OAuth methods when available, otherwise an API key whose message is deleted from Telegram). What happens when an account hits a usage limit is set in /limits. Text forms: /accounts add <name>, /accounts use <name>, /accounts login <name>, /accounts remove <name>, /accounts autoswitch on|off. /account, /connect [provider [key]] and /disconnect [provider] still work as hidden aliases (the menu lists only /accounts). See Several accounts |
/effort |
Set reasoning effort (per-thread) via inline buttons. Claude: native /effort levels (low…ultracode). OpenCode: the current model's variants, applied per-prompt. No env configuration |
/verbosity |
Output-verbosity macro (minimal|short|full): sets the thinking, tool-results and sub-agent display prefs at once; /thinking, /tool_results, /subagent point-override afterwards. Mixed prefs show as "custom" in the picker. The picker's second row (or /verbosity stream|stream_answers|answers) sets what the topic SHOWS — "Stream only" (default), "Stream + answers" (the stream plus the agent's pinned answers) or "Answers only" (the pinned answers, no stream; an agent that keeps writing after its final answer is reminded once to send what matters); a switch applies from the next message, and /status names the view |
/thinking |
Chain-of-thought display: full keeps the reasoning, short collapses to "💭 thought for Ns", minimal keeps only the live working cue |
/tool_results |
Completed tool-call output: full whole body, short capped (15 lines / 1200 chars), minimal transient 🔧 status only |
/subagent |
Sub-agent transcript: status-only with a ticking elapsed counter (minimal/short), or streamed "🤖 ⤷" chunks (full) |
/sessions |
List & resume previous sessions in this folder |
/rename_session |
Rename the current live session (OpenCode; Claude transcripts have no title) |
/quit, /q |
End the session — Claude: graceful double Ctrl+C; OpenCode/terminal: stopSession. Releases the persisted session id, so a bot restart won't auto-reattach it (resume later via /sessions). A topic whose agent process is gone but whose session is kept (it "sleeps": the next message, file, voice note, /compact, /model or /effort resumes it by itself) is released the same way |
/new, /clear_session |
End the current session and start a fresh one (same adapter) |
/status |
This thread's status: agent, bound folder, the Claude account it runs on and the resolved workdir; a live session also shows the model it is actually running, effort, start time, runtime version and context use (anything the backend cannot report renders as unknown). On a Claude topic the account is its profile (name · email as in /accounts, marked ⛔ while it is at its limit, with a second row for a switch still pending); an OpenCode topic's model already names its provider |
/output |
Last 500 lines of agent output (sent as at most 5 chunks; the overflow is reported as omitted) |
/c, /y, /n |
Ctrl+C / "y" / "n" |
/enter, /up, /down, /tab |
tmux key passthrough |
/esc, /escape |
Send a raw Escape — interrupt the current turn / dismiss a selector |
/schedule |
Schedule a prompt in free text — the agent parses the time and owns the job; see Scheduler |
/reminders |
Reminders set with buttons only — the bot posts and pins them itself, with no agent involved; works in any topic, bound or not. See Reminders |
/clear_messages |
Delete bot messages in this topic (up to 48h, Telegram limit) |
/clear |
Forwarded to the agent (Claude wipes context; OpenCode plain text) — not a bot command anymore. Also purges the topic's file-intake dir |
/compact |
Compact the agent's context — a real, confirmed compaction on OpenCode and on the default (stream) Claude backend; the tmux Claude backend has the literal command forwarded (its TUI compacts); terminal: not supported |
/compact_on_idle |
Toggle auto-compaction after ~55 min idle (Enable/Disable picker; AGENT_IDLE_MINUTES sets the window). Per topic; run it in General to set the default for all topics. On by default. Each idle compaction posts one short notice; the picker's «Show summary» / «Hide summary» row (the /compact_summary switch) adds the agent's full summary after it. Fires at most once per active period (until you write again); if a question was pending it is re-asked with tappable buttons after the compaction. On the json-stream backends the idle mark also STOPS the agent process, compaction or not — the topic sleeps and your next message resumes it (/status says so) |
/compact_summary |
Toggle posting the agent's full summary after a compaction — /compact, the idle compaction and the agent's own compact_conversation (Enable/Disable picker). Per topic; run it in General to set the default for all topics. Off by default: a compaction ends in a short line. On OpenCode it also hides the summary OpenCode streams itself |
/limits |
Everything about a usage limit on one screen, with a short text: at the top each Claude account's usage windows exactly as /accounts shows them, under a «Usage (% used)» heading (default — ⏱ 5h 5% 🔄 in 4h · week 20% 🔄 in 5d 8h · Fable 4% 🔄 in 5d 8h; a signed-out account is named, one never polled is left out), then what the topic runs on and where its two settings come from. Fallback models — an ordered list of Claude accounts (with an optional model) and OpenCode providers with a model, top = preferred, where a topic continues when its agent hits a limit. One full-width button per entry (1. Claude · work · opus ⛔ 14:00 — limited until, 🔒 not signed in, ❓ no longer offered, 🚫 left out of automatic switching, ✓ where the topic runs); a tap opens that entry in the same message with ⬆️ Up / ⬇️ Down, 🚫 Don't use / ✅ Use (a left-out entry stays usable by hand through /model and /accounts), 🗑 Remove and ⬅️ Back. Below the list: «➕ Add» (account or provider, then the model), «🔄 Fill from connected» (a draft from what is connected; entries you left out stay left out; asks first when a list exists), «🗑 Clear». The list is ONE instance-wide list and is editable from every topic. Two settings decide what a limit does: «🔁 Auto switch» — auto switch to a fallback model (OFF by default: the limit notice carries «🔁 Switch to …» buttons instead) and «⏳ Wait for reset» — wait for the reset and continue (ON by default; while a wait is armed the topic screen also offers «⏭ Skip once»). In General they are the defaults for all topics and each is one button that flips the value. In a regular topic each is one short full-width button showing the effective value (🔁 Auto switch: ON; one line of text above the list says where each value comes from — 🔁 as in General · ⏳ set for this topic); a tap opens the setting in the same message with ON / OFF / «As in General ()» — the topic's own choice marked ✓ — and ⬅️ Back, and a choice applies and returns to the screen. Switch ON: the topic moves to the first available entry at once. OFF: buttons on the notice, and if none is pressed the bot waits for the reset (waiting ON); both OFF: it only reports the limit. When every enabled entry, the current one included, is limited, the wait ends at the EARLIEST reset and the topic continues on that entry (the notice names it and the time). Text forms: /limits rebuild, /limits clear, /limits switch on|off|same, /limits wait on|off|same. /fallback and /auto_continue_limits [on|off] still work as hidden aliases. See Usage limits and the fallback models |
/bind |
Bare: current binding + folder picker, with «leave current dir» (the old /unbind) and «create new folder» buttons |
/mcp |
List MCP servers active for this thread |
| Command | Description |
|---|---|
/start |
Intro: work root + available agents |
/help |
Context-aware help |
/ls |
List the project subfolders of the folder the bot was launched from |
/list |
List existing topics and their bindings |
/status |
This topic's status; in General — a global view of all topics + active agents. A non-General topic also reports the account it runs on (Claude profile · email, ⛔ at its limit) and the resolved workdir; a live one the model actually running, runtime version and context use (unknown when the backend cannot report it) |
/doctor |
Self-diagnose: admin rights, privacy mode, paths, CLIs |
/version |
Versions: bot, claude, opencode, node, tmux |
/whoami |
Show userId, chatId, threadId, isAllowed, binding |
/trace |
Output-trace recorder (on/off, on all/off all; bare = status) — see Observability |
/timestamps |
Prepend the send time to prompts forwarded to the agent (on/off; bare = status) |
/language, /lang |
Set the bot UI language for this chat; bare opens an endonym picker (sorted A→Z by English name), /language auto returns to automatic per-chat detection |
/timezone |
Set the timezone every clock the bot touches speaks in — schedules, agent time context, time renders. /timezone Europe/Moscow, /timezone +04:00, /timezone auto (host zone); bare opens a region → zone picker. Instance-wide, not per chat |
/pair |
Bind this forum supergroup to the bot (re-point auto-pairing) — works from any topic of the target group; a numeric ALLOWED_GROUP_ID env locks pairing |
| Command | Description |
|---|---|
/quit-all, /quitall |
End every active agent in every bound topic (also releases their session ids) |
In a bound topic you can also type:
claude fix the bug/opencode add tests- A plain message after
/claudeis already running → routed as input.
Voice messages are transcribed via Groq Whisper (free) or OpenAI Whisper (fallback) and follow the same routing. If the provider times out or fails temporarily, the bot says so in the topic and retries automatically (after 5 s, then 15 s) — no need to re-record the voice note.
/terminal is never started from a natural-language phrase — only the
explicit command opens a shell.
"Claude Code" in a topic is one user-facing choice with three interchangeable backends:
- json-stream (
/claude_mode json) —claude -pin stream-json mode as an external tmux-hosted process emitting structured events. Cleaner output, and it survives bot restarts (the bot re-adopts the process and replays what was produced during the downtime). After ~55 min idle (AGENT_IDLE_MINUTES) the process is stopped — right after the idle compaction when/compact_on_idleallows one. The default. - per-turn (
/claude_mode per-turn) — the same host, stopped right after every answer. Nothing is lost: the conversation sleeps and your next message resumes it. Needs Claude Code 2.1.287 or newer; the switch is refused when the topic's last known version is older. - tmux-scrape (
/claude_mode tmux) — the classic TUI driven by keystrokes inside tmux; output is scraped from the pane. Never stopped automatically.
A stopped json-stream conversation sleeps: /status says so, and the next
message, file, voice note, /compact, /model or /effort resumes it by
itself — same session, prompt cache still warm, no "started" notice. A
process is never stopped while it works (a running turn, a background task,
a message not yet taken in). Only /quit, /new and leaving the folder end
the conversation.
/login works on all three backends. tmux-scrape hosts the sign-in inside its
TUI; the json-stream backends (which have no TUI) run it out-of-band — the bot spawns
claude auth login in a pty, posts the sign-in link into the topic, and takes
your pasted code back (the code message is deleted and a 🔐 confirmation is
posted). While the sign-in waits for the code, a message that is not a code
is answered with a waiting hint instead of being swallowed; /esc cancels
the pending sign-in (the link message says so).
All three drive the same claude CLI against the same on-disk
transcript, so /claude_mode switches a live topic seamlessly — the
conversation resumes on the other backend. The pick persists per topic
(/claude reopen it; on a sleeping topic they resume it).
Billing note: the json-stream backends strip ANTHROPIC_API_KEY from the
agent's env, so usage bills to your Claude subscription rather than an API key.
If you hold more than one Claude subscription (a personal Pro/Max and a corporate Team/Enterprise seat, say), the bot keeps each signed in as its own profile and lets you choose, per topic, which one a Claude session runs on — so one account's usage limit does not stop every topic.
- The profile
defaultis your existing~/.claudelogin; nothing is migrated. An added profile is a Claude config directory of its own underDATA_DIR/claude-profiles/<name>/(the CLI gets it throughCLAUDE_CONFIG_DIR): it holds that account's login, while the transcripts, settings, skills, plugins and your user memory are symlinks back into~/.claude— every account sees the same hooks and skills, and a conversation started under one account resumes under another. - Adding an account:
/accounts→ «➕ Claude account» (or/accounts add work) — give it a short name, then open the sign-in link the bot posts in a browser that is signed in as that other account (an incognito window or another browser profile keeps your current login out of the way), finish the sign-in and paste the code back into the topic. The code message is deleted; the bot confirms with the account's email and plan. - Switching: tap a profile in
/accounts(or/accounts use <name>). A running session on the default (stream) backend is restarted under the new account with the same conversation — right away when idle, at the end of its turn when it is working; a sleeping topic simply resumes under it. The tmux-scrape backend is reopened the same way when idle and waits for the next start when busy. In the General topic the pick is the default for all topics; a topic with its own pick keeps it («↩ Follow the default» drops it). A profile that is not signed in cannot be picked. - Removing: «🗑 Remove» deletes the profile's login directory. The profile
that is currently the instance default cannot be removed (pick another one in
General first); topics that had picked the removed profile return to the
default and the confirmation says how many. For
default(~/.claudeitself) «remove» means sign out: after a confirmation that says running sessions on it will stop working, only the stored subscription login (claudeAiOauthin~/.claude/.credentials.json; MCP tokens beside it stay) is deleted —projects/, settings, skills, plugins and memory are never touched — and the account is hidden from the list, the recommendation and the fallback ranking until it is signed in again (/accounts login default). - A child
claudethe agent starts inherits the sameCLAUDE_CONFIG_DIR, so it runs on the topic's account too. - Usage per account. Under each profile
/accountsshows how much of each subscription window is used and when it resets: the 5-hour session window, the weekly window (all models) and Fable's own weekly window (left out entirely on a plan without one). A line reads5h 5% 🔄 in 4h · week 20% 🔄 in 5d 8h · Fable 4% 🔄 in 5d 8h— the percentage is USED. A reset is shown as a time from now (🔄 in 2d 1h; the two largest units, minutes only under an hour); an unknown 5h reset shows the weekly one, and with no reset at all only the percentage is shown.telegramcode claude-profilesprints the same relative form; its--jsonand the MCP tool keep ISO instants. The bot reads the figures with each profile's own login every 10 minutes, when/accountsor/limitsopens and when an agent asks; a json-stream session's own rate-limit events keep them current between polls. A token the CLI has not renewed yet shows the last figures as(stale); a profile whose session was refused on a window is marked⛔ at its limit until …and is skipped by the recommendation below. - Another account takes over on a limit. When a topic's account hits a
usage limit the bot looks at the fallback chain;
without one it ranks the other signed-in profiles by headroom on the windows
the topic's model drains (fresh figures, not marked limited). The limit
notice carries «🔁 Switch to » buttons, best first: a tap moves the
topic there (the running session is restarted under the new account with the
same conversation), drops the wait for the reset and tells the agent to
continue right away. With switching on («🔁 Auto switch to a
fallback model» in
/limits, or/limits switch on; in General the default for all topics) the bot does the same by itself and posts one line — «Usage limit on a — this topic switched to b and continues», naming when the exhausted account resets. It is OFF by default: moving work between subscriptions is your call. The exhausted profile is marked limited until its window resets, so it is not picked again before then; the topic is never moved back by itself — switch it back by hand when the window resets. When nothing can take over the bot waits for the reset as before. An agent that is still working switches at the end of its turn (the wait stays armed). - Which account for a child process. An agent that launches a detached
claude(a worker, a reviewer) asks the bot'stelegramBotMCP toolclaude_profiles— optionally with the model it will run — and gets every profile with its windows plusrecommended: the signed-in, unlimited profile with the most headroom (Fable → Fable's weekly window and the session window; any other model → the shared weekly window and the session window). It then starts the child withCLAUDE_CONFIG_DIR=<configDir>(null= the default profile: set nothing). The same answer from a shell, for a worker without MCP:telegramcode claude-profiles [--best] [--model <name>] [--json]—--bestprints just the directory (an empty line for the default), soCLAUDE_CONFIG_DIR="$(telegramcode claude-profiles --best --model fable)"works as is; it reads the bot's cache offDATA_DIR/state.json.
When a topic's agent stops on a usage limit — a Claude account window, an
OpenAI quota through OpenCode, a Google RESOURCE_EXHAUSTED — the bot can keep
the work going somewhere else instead of waiting. /limits holds ONE
instance-wide, ordered list of fallback models (where to go), top = preferred:
- Left out of switching. ✅ / 🚫 on a row includes or excludes that entry from
automatic switching and from the notice's switch buttons. A connected
provider (say OpenAI on OpenCode) can stay usable by hand through
/modelwhile the bot never moves a limited topic onto it. With an EMPTY chain the bot still ranks the other signed-in Claude accounts by headroom; once the chain has entries, only its ✅ entries count — all of them left out means no switch, the wait stands. - Entries. A Claude account profile (
/accounts) with an optional model (fable,opus,sonnet,haiku; «keep the topic's model» otherwise), or an OpenCode provider with a model (openai/gpt-5,google/gemini-2.5-pro, …). Only what is actually connected is offered: the signed-in profiles, and the providers the OpenCode server is authenticated for (its live catalog). - Drafting. «🔄 Fill from connected» (or
/limits rebuild) writes a draft from what is signed in: the Claude accounts in their/accountsorder (keeping the topic's model), then the OpenCode models topics picked recently, then every other provider's strongest model; an account or provider you had left out of switching (🚫) stays left out. Tap an entry to move it (⬆️ Up / ⬇️ Down), include or leave it out, or remove it; add with «➕ Add» (pick the account or provider, then the model). Editing works from every topic (it is one instance-wide list); a topic also sees ✓ on the entry it runs on now. - On a limit the bot marks the exhausted entry limited until its window
resets (the reset the error names, else the account's session window, else
an hour), skips entries that are limited, not signed in or no longer offered,
and takes the first remaining one. A topic whose account or model was picked
by hand (
/accounts,/model) is left alone until it hits its own limit — then the chain decides, from the top. The «🔁 Auto switch» setting (auto switch to a fallback model) applies: OFF (the default) puts «🔁 Switch to …» buttons on the limit notice, ON switches by itself. No entry available → the wait (when «⏳ Wait for reset» is ON) — for the entry that comes back first: when every enabled entry, the topic's current one included, is limited, the armed wait is re-aimed at the entry whose limit resets EARLIEST (the notice says which model the topic will continue on and when, also with auto switch OFF). The target rides in the persisted retry record, so a restart keeps it; when the timer fires the topic is moved there first (a context bridge across backends), then the usual continue prompt follows. If the current entry resets first (or within a minute of the first), nothing changes. - Within a backend the conversation is kept: Claude account → account keeps
the transcript (
--resumeunder the other account), OpenCode provider → provider keeps the session and changes the model. Across backends (Claude ↔ OpenCode) the topic's agent changes: the old session is stopped and its id parked, the new one is started (or resumed, when the topic ran on that backend before) and its first prompt is a context bridge — why it takes over, the previous agent's last turns verbatim, and the instruction to check the project state (git status / diff / log) before carrying on and to report in one short message what the task is, what is done and what remains. A later/claudeor/opencodereturns to the parked conversation;/newand/quitrelease it as usual. - The topic is never moved back by itself when the exhausted entry resets
— the switch notice names the reset time; switch back by hand (
/accounts,/model,/claude,/opencode).
A topic can have scheduled prompts: at fire time the bot posts the prompt into the topic, pins the announcement (pins accumulate as run history), waits for a busy agent to go idle (up to 10 min, rather than interrupting live work) and delivers it — reusing the active session or starting one with the thread's last-used backend.
/schedule <free text>is a thin wrapper — the bot owns no date parsing. The agent interviews you (bare/schedule) or parses "every day at 9" / "tomorrow 15:00" itself, then calls the bot-injectedschedule_create/schedule_list/schedule_cancelMCP tools (cron, one-shot, or N-times; min interval 5 min; up to 30 agent jobs per topic — reminders are counted separately, see below).- Restart-safe: timers re-arm at boot; a run missed during downtime fires one catch-up annotated with the missed time.
- Leaving a folder pauses the topic's scheduled prompts;
/bindresumes them (an expired one-shot is dropped). Reminders keep running — see below. Run history:DATA_DIR/scheduler-runs.jsonl.
A reminder is the bot's own notification, not a job for an agent: at the due time the bot posts your text into the topic and pins it — and the pin is what notifies you through a muted topic. Nothing is started and nothing is interrupted, so reminders work in any topic, with or without a bound folder and with or without a running agent.
/reminders opens a hub with «➕ Add», «📋 List (N)» and «✕ Close». Add walks
four steps, all in the same message:
- How often — once, every day, weekdays, weekly, monthly.
- Which day — a date (today / tomorrow / a date grid), a weekday, or a day of the month. Skipped for "every day" and "weekdays".
- What time — four quick presets, or «🕐 Other time» → the hour, then the minutes in 5-minute steps.
- The text — type it or send a voice note, up to 1000 characters.
Steps 1–3 are buttons only: the reminder text is the one thing you type.
‹ Back changes a pick, ✕ Cancel drops the wizard, and any command cancels
it. Picking a time that has already passed says so instead of quietly moving
the reminder to tomorrow, and a text over the limit is refused with nothing
saved — send a shorter one and the reminder is created from that.
The finished reminder shows when it fires, its text and its next run. «📋 List» pages through the topic's reminders (8 per page); tapping one opens it with a «🗑 Delete» button — the card shows exactly what you are deleting, so there is no extra confirmation step. A topic holds up to 100 reminders — counted separately from the agent's scheduled prompts, so neither takes slots from the other — and they survive a restart, with one missed while the bot was down firing a single catch-up.
Reminders are yours, not the agent's: the scheduling tools an agent can call do not see them, so it can neither list nor delete them.
/terminal binds the topic to a real interactive $SHELL (in tmux) in the
bound folder — a third backend alongside the agents, mutually exclusive
with them. Every plain message is typed in as a command; output streams
back as one rolling message per command. Raw keys reuse the TUI commands:
/c (Ctrl-C), /up /down (history), /tab (completion), /enter.
Restart-safe like the agents: the shell survives a bot restart and is
re-adopted. Known v1 limitation: full-screen TUIs (vim, htop, less) render
messy; normal commands, builds, and logs stream cleanly. The shell comes
from the SHELL env (fallback /bin/bash).
Send a file to a bound topic with an active agent and the bot hands it to the agent:
- Six kinds: photo, document (incl. PDF), video, video note, audio, animation. Voice is not intake — it stays on the transcription path.
- The file is downloaded to
DATA_DIR/files/<chatId>_<threadId>/(bot-owned, never inside your project folder) and announced to the agent as[Telegram file] … saved to: <path>plus your caption. - A media album (several files sent as one message) is batched into ONE
combined
[Telegram album]prompt instead of N separate ones. - Limits and cleanup: 20 MB per file (Telegram Bot API cap); forwarding a
bare
/clearpurges the topic's intake dir (the agent's context is gone, so the files are useless); files older than 30 days are swept daily.
- Output trace — ON by default for every thread: each incoming update,
adapter emit, and outgoing Bot API call (with outcome, incl. 429 details)
is recorded into hourly buckets
DATA_DIR/output-trace-*.jsonl(pruned after 6h)./trace off allturns it off durably; bare/tracereports status. This is the source of truth when debugging "a message never reached the topic". - Console tee — the bot's stdout/stderr is mirrored to
DATA_DIR/bot-console-*.log(same hourly buckets, same 6h prune), so boot logs stay readable post-incident without the operator's terminal. /timestamps on— prepends each forwarded prompt's send time (local-offset ISO) so a days-long session knows what "yesterday" means. Agent-facing only, default off, persisted per topic.
The bot runs on the host clock, which on a typical server is UTC. /timezone
declares yours ONCE, instance-wide, and every clock the bot touches follows:
- Schedules fire at your wall-clock time. Changing the zone PRESERVES the wall clock — "9am" stays 9am rather than drifting by the offset — and every job's next run is recomputed on the spot (an expired one-shot is dropped).
- The agent is told the current time and zone with each
/schedulerequest, and carries the zone in its thread-context preamble, so "remind me tomorrow at 9" resolves against your clock instead of the model's assumption. - Time renders — "missed at HH:MM", schedule descriptions,
/timestampsinjection and theschedule_listnext-run stamp all read in your zone.
/timezone Europe/Moscow # IANA name
/timezone +04:00 # fixed offset (accepted; does not follow DST)
/timezone # region → zone picker
/timezone auto # back to the host zone
The current zone and its wall clock also show in /status. Nothing is stored
until you set one, so an install that never runs /timezone behaves exactly as
it did before.
| Variable | Description |
|---|---|
TELEGRAM_BOT_TOKEN |
Token from @BotFather |
Start from the parent folder containing your projects: cd ~/projects && telegramcode.
That $PWD is the folder the bot works in — nothing else to set for it.
Access control. There is no user allow-list. Whoever is a creator or
administrator of the served forum group may talk to the agent — read live from
Telegram (getChatAdministrators) and cached for 1h. Promote someone in the
group to grant access; demote/remove them to revoke it — the bot subscribes to
chat_member updates, so an admin change invalidates the cache and takes
effect immediately (the 1h TTL is only the fallback). The bot must be a group
admin itself (it already needs that to create topics and pin). Anonymous admins
can't be matched from their messages, so post non-anonymously. The DM surface
(when enabled) is gated separately: only the configured OWNER_USER_ID may
talk to the bot there.
Security model — group admin (or the DM owner) ⇒ shell on the host. The agents run with permission checks disabled (
--dangerously-skip-permissionsfor Claude, auto-approve for OpenCode) and/terminalopens a raw$SHELLin the bound folder, so anyone who can talk to the bot can execute arbitrary commands as the bot's OS user. Only promote people you would trust with SSH access to that machine, and keep the served group itself private.
| Variable | Default | Description |
|---|---|---|
ALLOWED_GROUP_ID |
(auto-pair) | Numeric forum supergroup id (-100…). Leave empty to auto-pair with the first forum group a group admin/creator contacts the bot from (id is saved to state.json; re-point with /pair). A name is not accepted. A numeric value disables auto-pairing |
DATA_DIR |
~/.telegramCode |
Per-instance state. Mandatory if you run two bots on the same host — otherwise both share state.json and mcp.json and corrupt each other |
CHAT_MODE |
both |
Which surface(s) this instance serves: group, dm, or both — see Two surfaces |
OWNER_USER_ID |
— | Optional. Numeric Telegram user id of the owner — leave it unset to run group-only (the DM surface stays inert; a group works fully without it). Set it only to enable the owner-DM surface; required solely for CHAT_MODE=dm |
GROQ_API_KEY |
— | Recommended for voice transcription. Without it, voice messages are not transcribed unless you intentionally configure the OpenAI fallback |
Localized in 12 languages — the bot UI (commands, buttons, notices) speaks
中文, English, Français, ქართული, Deutsch, हिन्दी, 日本語, Português, Русский,
Español, Українська, Oʻzbekcha. The language is automatic per Telegram chat:
explicit /language <locale> override wins, then the sender's Telegram client
language, then the last supported Telegram locale seen for that chat, then
English.
Supported locales: en, de, fr, es, pt, ru, zh, ja, hi, uz,
ka, uk. Bare /language opens a single-message inline picker with each language
shown by its own name (endonym), sorted A→Z by English name, and a 🌐 Auto button
(all 12 fit at once — no pagination). Tapping a language (or 🌐 Auto) applies it, then the menu
disappears and a short confirmation stays in the chosen language;
/language auto returns a DM/group to automatic selection.
Agent provider/auth setup is normally done inside the agents themselves:
claude login for Claude CLI and /connect <provider-id> (for example,
/connect openrouter) or OpenCode's own config/plugins for OpenCode. No provider
API key env var is required by the bot for text sessions. For OpenCode, install
any third-party provider plugins or authentication resolvers before launch if
your chosen providers need them.
| Variable | Default | Set only when |
|---|---|---|
WORK_ROOT |
$PWD |
You cannot control the process cwd; normal launch uses cd <projects-parent> && telegramcode |
OPENCODE_URL |
http://localhost:4096 |
You use a custom OpenCode port or external server; the port must differ per instance |
OPENCODE_USERNAME |
opencode |
OPENCODE_PASSWORD is set for a protected OpenCode server |
OPENCODE_PASSWORD |
— | Connecting to a protected OpenCode server |
OPENCODE_ALLOW_REMOTE |
— | OPENCODE_URL intentionally points outside loopback |
OPENCODE_BIN |
(auto) | The opencode binary is not on PATH or you use a fork |
CLAUDE_BIN |
(auto) | The claude binary is not on PATH due to nvm/asdf/systemd PATH differences |
OPENAI_API_KEY |
— | You intentionally use OpenAI Whisper as the voice fallback instead of Groq |
ANTHROPIC_API_KEY |
— | A custom MCP/OpenCode plugin/auth resolver explicitly reads it; not needed for normal Claude CLI auth. The json-stream Claude backend strips it from the agent's env (subscription billing) |
SHELL |
/bin/bash |
You want /terminal to open a different shell than your login shell (host env var, not set by the bot) |
SCHEDULER_MCP_PORT |
an OS-chosen free loopback port | You need a stable, explicitly chosen port; it must differ from this instance's OPENCODE_URL port |
CLAUDE_SCRAPE_DEBUG |
off | You are debugging Claude tmux scraping and need full RAW/FILTERED chunks |
AGENT_IDLE_MINUTES |
55 |
A json-stream Claude topic idle for this long is compacted (when /compact_on_idle allows) and its process stopped; the session sleeps and the next message resumes it — shorten it only for a test; a non-positive or non-numeric value keeps the default |
REQUEST_BACKSTOP_MINUTES |
90 |
A request (a Jira hand-over, a message in an answers-only topic) with nothing seen working on it for this long is re-posted to its session — shorten it only for a test; a non-positive or non-numeric value keeps the default |
TMUX_SOCKET_NAME |
— (the default tmux server) | The instance must run its agents on its OWN tmux server (tmux -L <name>; any plain name except default). Recommended for a second instance on one host: at boot an instance kills every agent session on its server that its own state does not know |
ENV_FILE |
— | Absolute path of the ONLY env file to read — no ~/.config/telegramcode/.env, no $PWD/.env; its values win over the inherited environment. Set it in the launching environment, never inside an env file (the start refuses that). scripts/run-isolated.sh <env-file> starts an instance with a clean environment plus this variable |
CONNECTORS |
telegram |
Experimental: the surfaces this instance serves, as a comma list — see Jira connector. An instance that lists jira refuses to start on Node below 22.12 and without ENV_FILE, TMUX_SOCKET_NAME and DATA_DIR/jira.json, and — with Telegram off — with a TELEGRAM_BOT_TOKEN or any ATLASSIAN_* variable in its environment. Any instance refuses to start on a DATA_DIR that holds conversations of a surface it does not serve |
WORK_DIR(1.x) is retired. Use the wrapper from the desired parent folder instead of carrying the old env forward.
The same core can serve Jira Cloud issues instead of (or next to) Telegram topics: an issue assigned to a dedicated AI account becomes a conversation with an agent, and the agent answers in comments.
a person assigns an issue to the AI account (in a trigger status)
→ the instance polls Jira as the AI account and opens a request
→ the agent works in the project's folder; its streamed output never reaches Jira
→ it answers through the answer_request tool:
progress → a comment, the issue stays with the AI
question → a comment, the issue goes back to the person who handed it over
final → a comment, the issue goes back to that person
→ an agent that stops answering is reminded; when the reminders give up, a
comment says a person has to look, and the issue goes back
- One issue = one conversation = one agent session, bound to the folder its project maps to. The agent reads the issue's text as information, never as instructions.
- The agent gets the whole issue. Every request's prompt carries the issue's fields, the full description,
its sub-tasks or an epic's children, links and remote links, an attachment list and ALL comments (oldest
first, restricted ones marked) — with a trusted group, minus what outsiders wrote (see below). A screenshot
or video pasted into the description or a comment shows up as a placeholder where it sat, naming its
attachment. Nothing is cut: a comment over 10 000 characters, or any text
that would not fit the prompt, is written whole to a file in the conversation's folder under
DATA_DIR/filesand the prompt says where. A later hand-over to the same conversation carries only what changed since the agent's last prompt (new and edited comments, deleted ones named, the rest listed as unchanged); a fresh session, or one whose context was compacted, gets the whole issue again. - Who gets the answer. Each hand-over is a request from its sender. Two people handing one issue over in turn get two answers, each their own comment; the first closing answer hands the issue back to its sender, the second finds the issue no longer the AI's and leaves the assignee alone. The same person handing over again replaces their earlier open request; the agent answers only what the new hand-over adds (if it already finished the first, a short pointer to that answer).
- Budget. An issue handed over more than
runBudgetPer24htimes in 24 hours is handed back with a notice and opens no request. - Who can steer it. With
trustedGroup(see Setup) only the members of ONE Jira group, the AI account and Jira's apps and automations count. A hand-over by anyone else — another person, a service-desk customer — opens no request: one notice on the issue names the group and the issue goes back to that person. Text written or edited by anyone else (a comment, the description, the summary, labels and extra fields, a file's name and content) is replaced in the prompt by a[withheld: …]marker, so the agent knows there is something and can ask its requester. WithouttrustedGroupeveryone who can edit or comment steers the agent, and the instance logs one line saying so.
-
Create a Jira account for the AI (its API token is the instance's only secret) and note its account id.
-
Recommended: create or choose a Jira group of the people whose words may steer the AI (for example
ai-trusted), and give the AI account the Browse users and groups global permission so that it can read the group. Then the agent reads only the text and files of its members and of Jira's apps and automations, and only their hand-overs start it. -
An instance of its own: a
DATA_DIR, aWORK_ROOTwith one folder per project, a private tmux server, and an env file that is the ONLY configuration it reads:# /path/to/jira-instance.env CONNECTORS=jira DATA_DIR=/path/to/jira-instance/data WORK_ROOT=/path/to/jira-instance/work TMUX_SOCKET_NAME=jira-instance OPENCODE_URL=http://localhost:4097 # a port of its own — the default 4096 is refused (other instances use it) JIRA_AI_API_TOKEN=... # referenced by jira.json below, never written there
-
DATA_DIR/jira.json— the allowlist, the trusted group and the credentials (${VAR}expands from the env file; an unknown key is an error):{ "site": "example.atlassian.net", "email": "ai-account@example.com", "apiToken": "${JIRA_AI_API_TOKEN}", "accountId": "<the AI account's id>", "projects": { "PROJ": { "folder": "proj", "triggerStatuses": ["In Progress"], "extraFields": ["customfield_10042"] } }, "trustedGroup": "ai-trusted", "pollIntervalSeconds": 90, "runBudgetPer24h": 5, "model": "opus", "effort": "high" }trustedGroup(optional, but without it everyone who can edit or comment steers the agent) is the group's NAME — one group per instance; a team with several trust circles runs a second instance. The instance resolves it to the group's id at start, so renaming the group while it runs keeps working, and reads its members again whenever its last read is older than 5 minutes: a removed member loses the AI's trust within that time. List only projects where only your team can write, and where no automation acts on text or actions from outside it — an e-mail handler, a portal form, a copy from another project, a rule that hands an issue to the AI when someone outside the team acts: an app's or automation's text and hand-over are trusted, so such a rule brings that outside text, or that person's hand-over, to the agent. Nor list a project where anyone outside the team holds the Edit all comments permission: Jira Cloud keeps no history of a comment's edits, so a comment is judged by its author and its LAST editor only — an outsider's edit of a member's comment, followed by a member's own edit, reads as trusted.projectsmaps each served project key to its folder underWORK_ROOTand the status names in which an assigned issue is a request; the agent loads that folder's project memory (CLAUDE.md,.claude/, … in it and in every parent) like any Claude Code session, while your user-level Claude setup stays out of its sessions — except that for a folder under HOME that walk reads~/.claude/CLAUDE.mdback in.pollIntervalSecondsis 10–600 (default 90);runBudgetPer24hdefaults to 5;modelandeffortset the sessions' Claude model and reasoning effort (optional; absent →opusandhigh, either key overrides only its own default).extraFields(optional, none by default) names fields by id (customfield_…, or a system one likeduedate) the agent should see next to the standard ones, shown under their site name; an id the site does not list is logged at start and left out.agentBinaries(optional, host runtime) maps a tool name to the absolute path of an executable — for example{ "ffmpeg": "/opt/tools/ffmpeg" }— which is checked at start and put on the agents' PATH.adapterisclaude-json-stream(the default — the agent process is stopped when an issue idles) orclaude-per-turn(stopped after every answer); either way the issue's conversation sleeps between requests and the next request resumes it. -
Start it with a clean environment, so nothing of the calling shell reaches it:
scripts/run-isolated.sh /path/to/jira-instance.env
The start refuses a missing
ENV_FILE,TMUX_SOCKET_NAMEorjira.json, anOPENCODE_URLon the default port, aTELEGRAM_BOT_TOKENor anyATLASSIAN_*variable when Telegram is off, a token that belongs to another account, an unknown project or status, atrustedGroupthe site does not have or the AI account may not read, and aDATA_DIRholding another surface's state. An unreachable Jira does not refuse the start — polling backs off and resumes.
The agent sessions of a Jira instance run without the user-level Claude settings, hooks and skills, with the
bot's MCP server only, without the native question tool, and with an environment reduced to a short allowlist
— the Jira token is not in the agent's environment. The agent still runs as the instance's OS user and can read
the instance's env file and DATA_DIR, so run the instance under an OS user that holds nothing else, with an AI
account that sees only the allowlisted projects. A production Jira account runs only in the Docker container
(Run with Docker): there the agent can still read the instance's env file and DATA_DIR,
but nothing of the host outside the container's mounts. Module details: src/connectors/jira/README.md.
The bot injects its own telegramBot MCP server into every bot-started session
— for Claude via a generated --mcp-config, for OpenCode via runtime
registration. It is loopback-only (127.0.0.1, on an OS-chosen free port unless
SCHEDULER_MCP_PORT explicitly pins one) and authenticated with per-session
HMAC bearer tokens scoped to the thread / directory. Every generated registration
also carries a unique client identity, so cancellation affects only the originating
agent even when two clients use the same JSON-RPC request id. It exposes:
schedule_create/schedule_list/schedule_cancel— the agent-side scheduling API behind/schedule;jira_get_attachment— Jira conversations only: saves the original of one attachment of the conversation's own issue (any size) and returns its path, so the agent can read an image or runffmpegon a video (with a trusted group, only a file uploaded by a trusted account);compact_conversation— lets the agent compact its OWN session when you ask it to in plain words ("compact our conversation"). It arms the compaction and returns immediately; the bot runs the real compaction the moment the current turn finishes (never mid-turn);send_file_to_user— lets the agent push files from the bound folder into the topic. A single MP4 uses Bot APIsendVideo; eligible all-video and mixed photo/video albums usesendMediaGroup, with each MP4 represented by anInputMediaVideoentry.as_file:trueexplicitly forces documents. Secure outbound file traversal currently requires Linux; on macOS this tool fails closed until a native descriptor-relative bridge is available. Existing path, count, caption, and size caps apply; canonical upload basenames have control characters and quoted-string metacharacters replaced before they enter multipart headers. Cancelling the MCP call removes queued work. While any upload stream is still being consumed, cancellation destroys the streams and aborts Telegraf, then returnsAbortErrorafter terminal cleanup. Once every request-body stream has ended, cancellation is too late to abort safely: the operation awaits Telegram's response, and any returned message IDs are durably recorded before success. Directory-scoped calls re-check the topic binding both before opening files and inside the per-topic delivery queue immediately before dispatch, so a queued call cannot continue after the topic is rebound elsewhere. Delivery and its durable/clear_messagestracking update share one per-topic queue transaction; the complete response-ID batch is on disk before success is reported. If Telegram has accepted a delivery but local tracking/cleanup then fails, the tool returns success with a warning and never retries. If the connection fails after an upload starts and Telegram's response never arrives, the tool returns a machine-readable, non-errordeliveryUnknownoutcome withretryable:false, preventing accidental duplicates.send_messages_to_user— delivers a batch of DISCRETE messages into the topic, each item posted as its OWN Telegram message in order (never merged) — for a per-item digest and similar. Each item is either a plain text string OR an object{text?, path?, as_file?}that may carry ONE attachment: apathitem reuses the SAME securesend_file_to_userpipeline (path relative to the bound folder, supported photos inline,.gifas animation,.mp4as video, everything else a document,as_fileforces a document), withtextused as the media caption (trimmed to 1024 chars — send long prose as its own text-only item). Items are validated up front (an empty object is rejected and nothing is sent); a total send failure returns an error, a partial one stays successful but reports how many landed, and an ambiguous attachment delivery surfaces as the same non-retryabledeliveryUnknownoutcome assend_file_to_user. Capped at 50 items per call.
This server is bot-owned plumbing; if its port fails to bind, the bot still
boots — only these agent-facing tools go inert. (Your own MCP servers still work
independently: Claude auto-loads them from ~/.claude/settings.json and a
project's .mcp.json; inspect what's active in a thread with /mcp.)
Third-party OpenCode MCP servers, including a separate telegram-mcp, belong to
the OpenCode configuration of the Linux user that runs the bot. They are not
injected by Charness; run opencode mcp list as that user to verify them.
Two host instances, or a host instance next to a container: each pair of variables below must differ to avoid
silent corruption. Two containers need only different tokens, groups, DATA_DIRs, container names and hostnames: their
ports and tmux servers are their own.
| What | Why it must differ |
|---|---|
TELEGRAM_BOT_TOKEN |
Telegram routes updates to a single long-poller per token; sharing → message loss |
ALLOWED_GROUP_ID |
The bot gates by group id; sharing → cross-instance leakage |
WORK_ROOT |
Each instance manages its subtree; sharing → tmux name collisions |
DATA_DIR |
state.json / mcp.json / threads/ per instance; sharing → corrupted JSON |
OPENCODE_URL port |
OpenCode server binds the port; second start fails with EADDRINUSE and you'd silently share sessions |
SCHEDULER_MCP_PORT |
Optional stable scheduler-MCP port; if set, it must differ from that instance's OPENCODE_URL port |
TMUX_SOCKET_NAME |
Optional, recommended: each instance's boot kills the agent sessions on its tmux server that its own state does not know — on one shared server, the other instance's |
scripts/self-update.sh refreshes a checkout in place, running as the
checkout's owning user — no root, no cross-user copying. It is safe to run
blindly (e.g. from cron):
- fast-forward only: it skips silently when the tree has tracked changes, a merge/rebase is in progress, or local history diverged from the upstream — a dev clone that is ahead of origin is never touched;
yarn install --immutableruns only whenyarn.lock/package.jsonchanged;- a hot-mode instance (
telegramcode hot) rebuilds and restarts the worker by itself (after a dependency install the script touchestsconfig.jsonsotsc -wrecompiles with the new modules); a non-hot instance getsyarn buildplus a restart notice — the script never kills processes; - changes to the hot supervisor itself (
src/cli.ts,src/cli/hot.ts,nodemon.json) are flagged with a warning: those need a manualtelegramcode hotrestart (nodemon reloads only the worker).
For unattended updates give the deploying user read access to the repo (e.g. a read-only GitLab deploy key on a passphrase-less SSH key) and add a cron entry:
*/10 * * * * /path/to/telegramcode/scripts/self-update.sh >> "$HOME/.local/state/telegramcode/self-update.log" 2>&1(create the log directory once: mkdir -p ~/.local/state/telegramcode).
Bot restarts are designed to be invisible: agents run in external
processes (tmux, opencode serve), so the bot re-adopts them instead
of killing them. In hot mode the long-lived supervisor starts the initial
opencode serve before nodemon, outside the replaceable worker's process
tree. If a worker later starts a replacement server after a crash, credential
reload, or late install, a one-shot host reparents that generation outside the
same tree before startup completes. An endpoint-bound process identity file
under DATA_DIR records a bot-started generation as starting before its host
releases it, then promotes it to ready after health succeeds. A successor can
therefore stop a pre-bind startup by its process-group identity, while ready
or adopted ownership is revalidated against the exact hostname and port before
a signal is sent, without trusting a reused PID or assuming an adopted listener
owns its process group.
A source rebuild therefore does not terminate an in-flight OpenCode turn.
The supervisor reads the same checkout .env as the worker before the initial
start. Hot mode supports Linux and macOS; it refuses to start on Windows because
nodemon cannot gracefully drain its worker tree there.
On boot the bot:
- Loads
state.json(archives tostate.json.corrupted-<ts>if parse fails, then starts fresh and notifies in General) and classifies the boot as a hot reload vs cold start from the persisted heartbeat gap. - Re-adopts live sessions per backend:
- Claude tmux-scrape (
claude-…) and terminal (term-…) sessions still instate.jsonare re-attached; orphan bot-owned tmux sessions are killed. The current pane seeds the baseline, so nothing is re-flooded into the topic. - Claude json-stream (
cjson-…) runs as an external process (stdin held on a FIFO, stdout appended to a file), so the restart never kills it: the bot adopts it and replays the downtime tail from the persisted offset — an in-flight turn is delivered end-to-end, and a pending interactive question is restored from its on-disk sidecar. A topic whose process is gone (stopped at the idle mark, or after its turn in per-turn mode) is NOT restarted at boot: it sleeps, and your next message resumes it. An adopted process started under an earlier bot build keeps that build's bot tools, so it is stopped once idle and resumed with the current ones. - OpenCode threads re-resume their stored session ids over the
shared SSE stream.
opencode serveitself is reconciled: a dead server is auto-restarted and the sessions restored (the in-flight reply is lost); a live server running an outdated binary is killed and respawned on the current one.
- Claude tmux-scrape (
- Re-arms pending API-error retries and scheduler timers; a run missed during the downtime fires one catch-up annotated with the missed time. A usage-limit wait that the previous process never recognised is also picked up: for a Claude json-stream topic the bot re-reads the tail of the session's output log and arms the resume itself (only for a limit error younger than 12 hours, only when nothing is armed already, and never the same one twice — a resume you skipped stays skipped).
- Stays silent on a quiet hot reload; a bounded recap of missed output is posted only when the agent kept working while the bot was down.
- Schedules
setMyCommandsso the Telegram client picks up the menu.
Explicit /quit, /quit-all, and leaving a folder (the /bind «leave
current dir» button) release the persisted session ids — those sessions
are not auto-reattached on the next boot (they stay reachable via
/sessions).
Closed-but-not-deleted topics keep their binding; only 400: message thread not found from a send triggers binding cleanup. Closed topics
are detected by TOPIC_CLOSED errors and surface a friendly message
asking the user to reopen.
In the Docker container (see Run with Docker) the same holds for a bot restart inside the container; a restart of the container itself ends every agent process, and each conversation resumes with its next message.
If you run the bot under systemd/systemd-run, set KillMode=process.
The default control-group mode kills tmux and opencode serve children,
which defeats restart/reattach. Process restarts intentionally leave agent
sessions alive; use /quit or /quit-all when you want to terminate them.
You disabled privacy mode in @BotFather after adding the bot. The flag is cached on join. Fix:
- Remove the bot from the group.
- (Re-confirm in @BotFather →
/setprivacy→ this bot →Disable.) - Add the bot back.
Verify with /doctor — the privacy line should report it as disabled.
The folder you launched from doesn't contain a subfolder with that name (or
it's a symlink pointing outside it). Run /ls to see what's available, or fix
the host path. Path-traversal attempts (../, absolute paths,
NUL bytes, NFC-vs-NFD mismatches) are rejected by design — see
validateSubdir in src/validation.ts.
The bot needs admin rights can_delete_messages and can_pin_messages
in addition to can_manage_topics. Open group settings → admins →
the bot → tick the missing boxes. /doctor shows the exact gap.
You forgot to set distinct DATA_DIR and OPENCODE_URL. The bot logs
[startup] DATA_DIR=<path> on boot — if both instances log the same
path, fix .env and docker compose down && up -d.
The 1.x adapter invoked claude --resume with no UUID and relied on the
interactive picker, which doesn't survive a non-interactive pty. 2.0
generates a UUID with crypto.randomUUID(), passes it via
--session-id, and resumes via --resume <uuid>. If you see a picker
anyway, your local claude CLI is older than 2.1.x — upgrade with
npm i -g @anthropic-ai/claude-code (the bot also auto-installs on
first use, see src/installManager.ts).
Two instances on the same host with the same OPENCODE_URL. Pick a
different port for the second instance (e.g. 4097).
How do I run Claude Code from my phone? Install Charness on your own machine or VPS, create a Telegram bot, and bind a forum topic (or the bot's DM) to a project folder. Start a Claude Code session in that topic and you drive it entirely from Telegram: type prompts, send voice notes, or drop in files, and the agent's output streams back into the same topic. Your phone never runs the agent; it stays on your machine.
Can I control OpenCode without opening any ports? Yes. The bot only makes outbound connections to Telegram, so nothing listens for inbound traffic and you never expose a port. OpenCode runs as a local HTTP server that the bot talks to on loopback, and you reach it from anywhere through Telegram.
How do I run a coding agent on a VPS and drive it from Telegram?
Set up your VPS once with git, your repos, the agent CLIs, and telegramcode, then launch the bot from your projects folder. You get an always-on dev box you drive from any device: phone, tablet, or voice. Because the agent lives on the server, it keeps working even when your laptop sleeps, and the same sessions are still reachable over plain SSH.
Does my session survive a restart? Yes, both a bot restart and an agent-server restart. State is persisted to disk; on restart the bot re-attaches to the running Claude session in tmux or re-connects to OpenCode, and an in-flight turn is delivered once it is back. A prompt sent during startup is buffered and replayed, never dropped.
Does it run both Claude Code and OpenCode? Yes. Each topic picks its backend independently: OpenCode over its native HTTP+SSE server, or Claude Code (tmux or json-stream). One topic is one project with its own isolated session, like terminal tabs, and two topics can point at the same folder for parallel work.
Can I talk to the agent by voice? Yes. Send a voice message to a topic and it is transcribed with Whisper (via Groq or OpenAI) and forwarded to the agent as a normal prompt, so you can vibe code hands-free from your phone.
- DEVELOPMENT.md — architecture and local development (build, test, hot-reload, Docker dev loop).
- MIGRATION_1_TO_2.md — upgrading a 1.x install to 2.0.
I started running Claude Code on my own machine, and I kept wanting to check on it after I stepped away from the desk. Back then there was no way to reach it from a phone, so I put together a small bot that launched the agent and let me talk to it over Telegram. It ran on my own computer, which had to stay on the whole time.
Then I moved the whole thing onto a server that never sleeps, added OpenCode next to Claude Code, and it grew into what it is now: voice control, file intake, scheduling, a raw terminal, and sessions that survive restarts. These days I run it every day and drive everything from my phone or tablet, no laptop required.
Full write-up: Vibe-coding by voice, from my phone.
MIT




