telegram-agent

Agent-first Telegram community management tools.

telegram-agent is an AgentCulture sibling repo. The shape it wears — pyproject layout, CLI conventions, vendored skills, CI pipeline — comes from steward's sibling pattern.

Status

Alpha. v0.2 lands the Telegram surface: telegram-agent bot send, telegram-agent group roster, telegram-agent group pin. Every write verb is dry-run by default; pass --apply to commit.

Install

uv tool install telegram-agent

Then telegram-agent --version should work on your PATH. uv tool install is the supported path — not pip install.

Usage

telegram-agent learn               # structured self-teaching prompt for an agent
telegram-agent learn --json        # same, as a JSON payload
telegram-agent explain             # top-level overview
telegram-agent explain whoami      # per-verb markdown
telegram-agent whoami              # nick + version + bot-token-configured probe
telegram-agent whoami --json       # structured payload

Every command supports --json where it produces a listing or report, and respects the exit-code policy (0 success / 1 user error / 2 env error). Errors carry a {code, message, remediation} shape; text mode renders as error: ... + hint: ... on stderr.

Telegram verbs (requires pip install 'telegram-agent[telegram]')

# read-only: count + admins + bot's own permissions
telegram-agent group roster --chat @announcements --json

# write (dry-run by default; --apply to commit)
telegram-agent bot send --chat @announcements --text "hello" --parse-mode markdown
telegram-agent bot send --chat @announcements --text "hello" --apply

# pin / unpin (also dry-run by default)
telegram-agent group pin --chat @announcements --message 123 --apply
telegram-agent group pin --chat @announcements --unpin --apply

Configuration

Bot tokens, group IDs, and webhook secrets must never be committed to the repo — keep them in repo secrets or a git-ignored .env.

Tokens are loaded from os.environ first, then from a .env file in the current directory, then from a .env at the nearest enclosing git root. Process env always wins. .env files that are world-writable on POSIX are skipped with a warning.

Testing

The unit suite runs offline. Run it with:

uv run pytest -v

Live smoke tests

Optional live tests in tests/test_telegram_live.py exercise bot send / group roster / group pin / unpin against the real Bot API. Enable by exporting two numeric chat IDs the bot can reach:

export TELEGRAM_AGENT_LIVE_TEST_USER_CHAT=<numeric user chat_id>
export TELEGRAM_AGENT_LIVE_TEST_GROUP_CHAT=<numeric group chat_id>
uv run pytest tests/test_telegram_live.py -v

The bot must be a member of the user DM (the user must have started a chat with the bot) and a member-admin (with Pin Messages) in the group. CI does not set these env vars, so live tests skip in CI.

Project shape

See CLAUDE.md for the directory layout, build / test / publish commands, and the sibling-pattern conventions telegram-agent inherits.

Contributing

Every PR must bump the version in pyproject.toml and prepend a Keep a Changelog entry to CHANGELOG.md. The version-check CI job enforces this. Use the vendored version-bump skill:

python .claude/skills/version-bump/scripts/bump.py patch  # or minor / major