telegram-userbot-cli 0.1.0__tar.gz

telegram_userbot_cli-0.1.0/.env.example

@@ -0,0 +1,25 @@
+# Copy to .env and fill in real values. Never commit .env.
+
+# Required: API credentials from https://my.telegram.org/apps
+TELEGRAM_API_ID=
+TELEGRAM_API_HASH=
+
+# Session string. Run `tg login --qr` to generate one (written to .env automatically).
+# Do NOT share this value, and do NOT reuse the session of another client
+# (e.g. an MCP daemon) — two live clients with one session will trigger
+# AuthKeyDuplicatedError.
+TELEGRAM_SESSION_STRING=
+
+# Proxy is required when Telegram is unreachable directly (e.g. in CN networks).
+# Common local setup: Clash mixed port, or a LAN socks5 proxy.
+TELEGRAM_PROXY_TYPE=socks5
+TELEGRAM_PROXY_HOST=127.0.0.1
+TELEGRAM_PROXY_PORT=7890
+# TELEGRAM_PROXY_USERNAME=
+# TELEGRAM_PROXY_PASSWORD=
+# TELEGRAM_PROXY_RDNS=true
+
+# Optional: stable device identity shown in Telegram Settings → Devices.
+# TELEGRAM_DEVICE_MODEL=
+# TELEGRAM_SYSTEM_VERSION=
+# TELEGRAM_APP_VERSION=

telegram_userbot_cli-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Install dependencies
+        run: uv sync --dev
+      - name: Ruff lint
+        run: uv run ruff check src/
+      - name: Ruff format check
+        run: uv run ruff format --check src/
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Build package
+        run: uv build
+      - name: Smoke-test the built wheel installs
+        run: |
+          uv venv /tmp/smoke
+          uv pip install --python /tmp/smoke/bin/python dist/*.whl
+          /tmp/smoke/bin/tg --version
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

telegram_userbot_cli-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: write
+  id-token: write # required for PyPI Trusted Publishing (OIDC token exchange)
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Build package
+        run: uv build
+
+      # Requires PyPI Trusted Publishing to be configured once:
+      # PyPI project "telegram-userbot-cli" → Publishing → Add Trusted Publisher →
+      # owner=noexcs, repository=telegram-cli, workflow=release.yml.
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+
+      - name: GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

telegram_userbot_cli-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.env
+.venv/
+__pycache__/
+*.py[cod]
+dist/
+*.egg-info/
+build/
+.DS_Store

telegram_userbot_cli-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

telegram_userbot_cli-0.1.0/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.5
+Name: telegram-userbot-cli
+Version: 0.1.0
+Summary: Full-featured Telegram command-line client powered by a Telethon userbot (your own account, not a bot token)
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: python-socks[asyncio]>=2.4
+Requires-Dist: qrcode>=8.0
+Requires-Dist: telethon<2,>=1.44
+Description-Content-Type: text/markdown
+
+# telegram-userbot-cli
+
+[![CI](https://github.com/noexcs/telegram-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/noexcs/telegram-cli/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/telegram-userbot-cli.svg)](https://pypi.org/project/telegram-userbot-cli/)
+
+Standalone Telegram command-line client. Connects directly to Telegram via
+[Telethon](https://github.com/LonamiWebs/Telethon) (MTProto userbot) — **no MCP,
+no daemon, no external service**. Everything the CLI does lives in the CLI.
+
+[中文说明](README-zh.md) · [Roadmap](ROADMAP.md)
+
+## Features
+
+- QR-code login (`tg login --qr`) with an independent session
+- Messaging: send / reply / edit / delete / forward / polls
+- Chats: list dialogs, history, pinned messages, in-chat & global search
+- Media: download, send files / albums, voice notes
+- Contacts & profile management
+- Chat resolution by name fuzzy match, `@username`, numeric id, or `me`
+  (Saved Messages), plus local aliases
+
+## Install
+
+Requires Python >= 3.10 and [uv](https://docs.astral.sh/uv/).
+
+```bash
+# from PyPI
+uv tool install telegram-userbot-cli   # or: pipx install telegram-userbot-cli
+
+# from source (development)
+git clone https://github.com/noexcs/telegram-cli.git
+cd telegram-cli
+uv tool install -e .
+```
+
+The `tg` command lands in `~/.local/bin/tg` (make sure `~/.local/bin` is on
+your PATH).
+
+## Configuration
+
+Copy `.env.example` to `.env` and fill in the values:
+
+| Variable | Meaning |
+|---|---|
+| `TELEGRAM_API_ID` / `TELEGRAM_API_HASH` | API credentials from https://my.telegram.org/apps (required) |
+| `TELEGRAM_SESSION_STRING` | Session string; generated automatically by `tg login` |
+| `TELEGRAM_PROXY_TYPE/HOST/PORT` | Proxy settings; **required** when Telegram is unreachable directly (e.g. CN networks). Common setup: `socks5` + `127.0.0.1:7890` (Clash) |
+| `TELEGRAM_PROXY_USERNAME/PASSWORD/RDNS` | Optional proxy auth / remote DNS |
+| `TELEGRAM_DEVICE_MODEL/SYSTEM_VERSION/APP_VERSION` | Optional stable device identity |
+
+Precedence: real environment variables > `.env` in the current directory >
+`.env` in the project root.
+
+## Login
+
+```bash
+tg login --qr      # scan the QR with your phone (Settings → Devices → Link Desktop Device)
+tg login --phone   # fallback: SMS code flow
+tg me              # verify
+tg logout          # remove the session
+```
+
+> **Note:** the session is independent — do not reuse the session string of
+> another live client (e.g. an MCP daemon). Two live clients sharing one
+> session trigger `AuthKeyDuplicatedError`.
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `tg me` | Show your account info |
+| `tg chats [keyword]` | List dialogs; `-t user/group/channel`, `-u` unread, `--archived` |
+| `tg hist <chat> [n]` | Recent messages (default 10) |
+| `tg send <chat> <text...>` | Send a message; `-p md/html` |
+| `tg reply <chat> <msg_id> <text...>` | Reply to a message |
+| `tg edit <chat> <msg_id> <new_text>` | Edit your own message |
+| `tg del <chat> <ids...>` | Delete messages (revoke for both sides) |
+| `tg fwd <src> <msg_ids...> <dst>` | Forward messages (last arg is the target) |
+| `tg dl <chat> <msg_id> [-o path]` | Download media (default `~/Downloads/telegram_<chat>_<msgid>`) |
+| `tg sf <chat> <files...> [-c caption]` | Send files; 2–10 files become an album |
+| `tg voice <chat> <file>` | Send a voice note |
+| `tg search <chat> <query>` | Search messages inside a chat |
+| `tg gsearch <query> [-p page]` | Global search across public chats |
+| `tg contacts` | List contacts |
+| `tg pinned <chat>` | Show pinned messages |
+| `tg poll <chat> "<question>" <opts...>` | Create a poll; `--multiple/--quiz/--public` |
+| `tg profile --name/--bio/--photo` | Update your profile |
+| `tg alias set/list/rm` | Local chat aliases (`~/.config/tg/aliases.json`) |
+
+Global flags: `--account` (v1: default only), `--json` (raw JSON output).
+Exit codes: `0` ok, `1` command error, `2` config/connection/session error,
+`130` interrupted.
+
+## FAQ
+
+- **`AuthKeyDuplicatedError`** — two live clients share one session. Run
+  `tg logout` then `tg login --qr` to create a fresh one.
+- **`FloodWaitError`** — Telegram rate limit; the CLI waits up to 60s
+  automatically, longer waits are reported.
+- **"cannot reach Telegram"** — check the proxy (e.g. Clash on
+  `127.0.0.1:7890`) and `TELEGRAM_PROXY_*` in `.env`.
+
+## Roadmap
+
+See [ROADMAP.md](ROADMAP.md) for the full plan (messaging enhancements, chat &
+group management, contacts, folders, multi-account, voice transcription).
+
+## License & acknowledgments
+
+[Apache-2.0](LICENSE). Proxy-injection approach, session-generation flow and
+environment variable naming inspired by
+[chigwell/telegram-mcp](https://github.com/chigwell/telegram-mcp)
+(Apache-2.0).

telegram_userbot_cli-0.1.0/README-zh.md

@@ -0,0 +1,105 @@
+# telegram-userbot-cli
+
+[![CI](https://github.com/noexcs/telegram-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/noexcs/telegram-cli/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/telegram-userbot-cli.svg)](https://pypi.org/project/telegram-userbot-cli/)
+
+独立 Telegram 命令行客户端。通过 [Telethon](https://github.com/LonamiWebs/Telethon)
+（MTProto userbot）直连 Telegram —— **不依赖 MCP、不依赖守护进程、不依赖任何外部服务**，
+所有功能都在 CLI 内完成。
+
+[English](README.md) · [Roadmap](ROADMAP.md)
+
+## 特性
+
+- 扫码登录（`tg login --qr`），使用独立会话
+- 消息：发送 / 引用回复 / 编辑 / 删除 / 转发 / 投票
+- 聊天：会话列表、历史记录、置顶消息、会话内搜索与全局搜索
+- 媒体：下载、发文件 / 相册、语音条
+- 联系人与个人资料管理
+- 会话解析：名称模糊匹配、`@username`、数字 id、`me`（已保存消息），以及本地别名
+
+## 安装
+
+需要 Python >= 3.10 与 [uv](https://docs.astral.sh/uv/)。
+
+```bash
+# 从 PyPI 安装
+uv tool install telegram-userbot-cli   # 或 pipx install telegram-userbot-cli
+
+# 从源码安装（开发）
+git clone https://github.com/noexcs/telegram-cli.git
+cd telegram-cli
+uv tool install -e .
+```
+
+`tg` 命令安装在 `~/.local/bin/tg`（请确保 `~/.local/bin` 在 PATH 中）。
+
+## 配置
+
+把 `.env.example` 复制为 `.env` 并填入真实值：
+
+| 变量 | 含义 |
+|---|---|
+| `TELEGRAM_API_ID` / `TELEGRAM_API_HASH` | my.telegram.org/apps 获取的 API 凭据（必需） |
+| `TELEGRAM_SESSION_STRING` | 会话字符串；`tg login` 自动写入 |
+| `TELEGRAM_PROXY_TYPE/HOST/PORT` | 代理配置；**本机必须代理**（如 socks5 + 127.0.0.1:7890 Clash） |
+| `TELEGRAM_PROXY_USERNAME/PASSWORD/RDNS` | 可选代理认证 / 远程 DNS |
+| `TELEGRAM_DEVICE_MODEL/SYSTEM_VERSION/APP_VERSION` | 可选设备标识（显示在 TG 设置→设备） |
+
+优先级：真实环境变量 > 当前目录 `.env` > 项目根目录 `.env`。
+
+## 登录
+
+```bash
+tg login --qr      # 手机扫码（设置 → 设备 → 链接桌面设备）
+tg login --phone   # 备用：短信验证码流程
+tg me              # 验证
+tg logout          # 退出登录并删除会话
+```
+
+> **注意**：本 CLI 使用独立会话——不要与其他在线的客户端（例如 MCP 守护进程）
+> 共用同一个 session 字符串，否则会触发 `AuthKeyDuplicatedError`。
+
+## 命令
+
+| 命令 | 说明 |
+|---|---|
+| `tg me` | 查看自己的账号信息 |
+| `tg chats [关键词]` | 会话列表；`-t user/group/channel`、`-u` 只看未读、`--archived` |
+| `tg hist <会话> [条数]` | 最近消息（默认 10 条） |
+| `tg send <会话> <文本...>` | 发消息；`-p md/html` |
+| `tg reply <会话> <消息id> <文本...>` | 引用回复 |
+| `tg edit <会话> <消息id> <新文本>` | 编辑自己发的消息 |
+| `tg del <会话> <id...>` | 删消息（双方撤回） |
+| `tg fwd <来源> <消息id...> <目标>` | 转发（最后一个参数是目标） |
+| `tg dl <会话> <消息id> [-o 路径]` | 下载媒体（默认 `~/Downloads/telegram_<会话>_<消息id>`） |
+| `tg sf <会话> <文件...> [-c 说明]` | 发文件；2–10 个自动合并为相册 |
+| `tg voice <会话> <文件>` | 发语音条 |
+| `tg search <会话> <关键词>` | 会话内搜索 |
+| `tg gsearch <关键词> [-p 页]` | 全局搜索公开频道 |
+| `tg contacts` | 联系人列表 |
+| `tg pinned <会话>` | 查看置顶消息 |
+| `tg poll <会话> "<问题>" <选项...>` | 创建投票；`--multiple/--quiz/--public` |
+| `tg profile --name/--bio/--photo` | 修改个人资料 |
+| `tg alias set/list/rm` | 本地会话别名（`~/.config/tg/aliases.json`） |
+
+全局选项：`--account`（v1 仅 default）、`--json`（原始 JSON 输出）。
+退出码：`0` 成功、`1` 命令错误、`2` 配置/连接/会话错误、`130` 中断。
+
+## 常见问题
+
+- **`AuthKeyDuplicatedError`** —— 两个在线客户端共用了同一个会话。先
+  `tg logout` 再 `tg login --qr` 生成新会话即可。
+- **`FloodWaitError`** —— Telegram 限流；60 秒内自动等待，更长的会明确提示。
+- **"cannot reach Telegram"** —— 检查代理是否存活（如 Clash 127.0.0.1:7890）
+  以及 `.env` 里的 `TELEGRAM_PROXY_*`。
+
+## 路线图
+
+完整规划见 [ROADMAP.md](ROADMAP.md)（消息增强、聊天与群管理、联系人、
+文件夹、多账号、语音转文字）。
+
+## 协议与致谢
+
+[Apache-2.0](LICENSE)。代理注入思路、会话生成流程与环境变量命名借鉴自
+[chigwell/telegram-mcp](https://github.com/chigwell/telegram-mcp)（Apache-2.0）。

telegram_userbot_cli-0.1.0/README.md

@@ -0,0 +1,113 @@
+# telegram-userbot-cli
+
+[![CI](https://github.com/noexcs/telegram-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/noexcs/telegram-cli/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/telegram-userbot-cli.svg)](https://pypi.org/project/telegram-userbot-cli/)
+
+Standalone Telegram command-line client. Connects directly to Telegram via
+[Telethon](https://github.com/LonamiWebs/Telethon) (MTProto userbot) — **no MCP,
+no daemon, no external service**. Everything the CLI does lives in the CLI.
+
+[中文说明](README-zh.md) · [Roadmap](ROADMAP.md)
+
+## Features
+
+- QR-code login (`tg login --qr`) with an independent session
+- Messaging: send / reply / edit / delete / forward / polls
+- Chats: list dialogs, history, pinned messages, in-chat & global search
+- Media: download, send files / albums, voice notes
+- Contacts & profile management
+- Chat resolution by name fuzzy match, `@username`, numeric id, or `me`
+  (Saved Messages), plus local aliases
+
+## Install
+
+Requires Python >= 3.10 and [uv](https://docs.astral.sh/uv/).
+
+```bash
+# from PyPI
+uv tool install telegram-userbot-cli   # or: pipx install telegram-userbot-cli
+
+# from source (development)
+git clone https://github.com/noexcs/telegram-cli.git
+cd telegram-cli
+uv tool install -e .
+```
+
+The `tg` command lands in `~/.local/bin/tg` (make sure `~/.local/bin` is on
+your PATH).
+
+## Configuration
+
+Copy `.env.example` to `.env` and fill in the values:
+
+| Variable | Meaning |
+|---|---|
+| `TELEGRAM_API_ID` / `TELEGRAM_API_HASH` | API credentials from https://my.telegram.org/apps (required) |
+| `TELEGRAM_SESSION_STRING` | Session string; generated automatically by `tg login` |
+| `TELEGRAM_PROXY_TYPE/HOST/PORT` | Proxy settings; **required** when Telegram is unreachable directly (e.g. CN networks). Common setup: `socks5` + `127.0.0.1:7890` (Clash) |
+| `TELEGRAM_PROXY_USERNAME/PASSWORD/RDNS` | Optional proxy auth / remote DNS |
+| `TELEGRAM_DEVICE_MODEL/SYSTEM_VERSION/APP_VERSION` | Optional stable device identity |
+
+Precedence: real environment variables > `.env` in the current directory >
+`.env` in the project root.
+
+## Login
+
+```bash
+tg login --qr      # scan the QR with your phone (Settings → Devices → Link Desktop Device)
+tg login --phone   # fallback: SMS code flow
+tg me              # verify
+tg logout          # remove the session
+```
+
+> **Note:** the session is independent — do not reuse the session string of
+> another live client (e.g. an MCP daemon). Two live clients sharing one
+> session trigger `AuthKeyDuplicatedError`.
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `tg me` | Show your account info |
+| `tg chats [keyword]` | List dialogs; `-t user/group/channel`, `-u` unread, `--archived` |
+| `tg hist <chat> [n]` | Recent messages (default 10) |
+| `tg send <chat> <text...>` | Send a message; `-p md/html` |
+| `tg reply <chat> <msg_id> <text...>` | Reply to a message |
+| `tg edit <chat> <msg_id> <new_text>` | Edit your own message |
+| `tg del <chat> <ids...>` | Delete messages (revoke for both sides) |
+| `tg fwd <src> <msg_ids...> <dst>` | Forward messages (last arg is the target) |
+| `tg dl <chat> <msg_id> [-o path]` | Download media (default `~/Downloads/telegram_<chat>_<msgid>`) |
+| `tg sf <chat> <files...> [-c caption]` | Send files; 2–10 files become an album |
+| `tg voice <chat> <file>` | Send a voice note |
+| `tg search <chat> <query>` | Search messages inside a chat |
+| `tg gsearch <query> [-p page]` | Global search across public chats |
+| `tg contacts` | List contacts |
+| `tg pinned <chat>` | Show pinned messages |
+| `tg poll <chat> "<question>" <opts...>` | Create a poll; `--multiple/--quiz/--public` |
+| `tg profile --name/--bio/--photo` | Update your profile |
+| `tg alias set/list/rm` | Local chat aliases (`~/.config/tg/aliases.json`) |
+
+Global flags: `--account` (v1: default only), `--json` (raw JSON output).
+Exit codes: `0` ok, `1` command error, `2` config/connection/session error,
+`130` interrupted.
+
+## FAQ
+
+- **`AuthKeyDuplicatedError`** — two live clients share one session. Run
+  `tg logout` then `tg login --qr` to create a fresh one.
+- **`FloodWaitError`** — Telegram rate limit; the CLI waits up to 60s
+  automatically, longer waits are reported.
+- **"cannot reach Telegram"** — check the proxy (e.g. Clash on
+  `127.0.0.1:7890`) and `TELEGRAM_PROXY_*` in `.env`.
+
+## Roadmap
+
+See [ROADMAP.md](ROADMAP.md) for the full plan (messaging enhancements, chat &
+group management, contacts, folders, multi-account, voice transcription).
+
+## License & acknowledgments
+
+[Apache-2.0](LICENSE). Proxy-injection approach, session-generation flow and
+environment variable naming inspired by
+[chigwell/telegram-mcp](https://github.com/chigwell/telegram-mcp)
+(Apache-2.0).