better-tg-cli 0.23.1 → 0.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -1
- package/README.ru.md +42 -1
- package/dist/telegram.mjs +1 -1
- package/package.json +1 -1
- package/skills/better-tg-cli/reference.md +7 -2
package/README.md
CHANGED
|
@@ -84,6 +84,11 @@ Every channel ships the same version from one release:
|
|
|
84
84
|
| [npm](https://www.npmjs.com/package/better-tg-cli) | CLI and MCP server (Node 20+) | `npm install -g better-tg-cli` |
|
|
85
85
|
| [GitHub Releases](https://github.com/TheVilfer/better-tg-cli/releases) | binaries and SHA256SUMS | download by hand |
|
|
86
86
|
| Claude Code plugin | skill and MCP server | [see below](#claude-code-plugin) |
|
|
87
|
+
| Claude Desktop extension | MCP server, runs on Claude's built-in Node | [download `.mcpb`](https://github.com/TheVilfer/better-tg-cli/releases/latest/download/better-tg-cli.mcpb) and open it |
|
|
88
|
+
| Grok Build plugin | skill and MCP server | [see below](#grok-build-plugin) |
|
|
89
|
+
| Gemini CLI extension | skill and MCP server | `gemini extensions install https://github.com/TheVilfer/better-tg-cli` |
|
|
90
|
+
| Cursor, VS Code | MCP server | [one-click buttons](#mcp-server) |
|
|
91
|
+
| Grok Bot | MCP server over HTTP from your Mac | [see below](#grok-bot-remote-mcp-over-http) |
|
|
87
92
|
| [skills.sh](https://skills.sh) | agent skill for any shell agent | `npx skills add TheVilfer/better-tg-cli` |
|
|
88
93
|
| [MCP Registry](https://registry.modelcontextprotocol.io/v0/servers?search=better-tg-cli) | MCP server entry `io.github.TheVilfer/better-tg-cli` | through your MCP client |
|
|
89
94
|
|
|
@@ -99,6 +104,16 @@ The skill and the MCP server together, in one install:
|
|
|
99
104
|
It runs the MCP server through `npx`, so Node 20+ is enough. Log in once with `telegram auth --qr`
|
|
100
105
|
(or `npx better-tg-cli auth --qr`) in a terminal.
|
|
101
106
|
|
|
107
|
+
### Grok Build plugin
|
|
108
|
+
|
|
109
|
+
[Grok Build](https://x.ai/cli) installs the same plugin, skill and MCP server together:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
grok plugin install TheVilfer/better-tg-cli --trust
|
|
113
|
+
# or add the marketplace first, then install from the /plugins menu:
|
|
114
|
+
grok plugin marketplace add TheVilfer/better-tg-cli && grok plugin install better-tg-cli --trust
|
|
115
|
+
```
|
|
116
|
+
|
|
102
117
|
### As an agent skill
|
|
103
118
|
|
|
104
119
|
The skill ([`skills/better-tg-cli`](skills/better-tg-cli/SKILL.md)) teaches any agent with a shell
|
|
@@ -161,7 +176,15 @@ tools over stdio:
|
|
|
161
176
|
- `telegram_read`: read-only, so clients may auto-approve it;
|
|
162
177
|
- `telegram_write`: marked destructive, and still needs `write-access on` from you.
|
|
163
178
|
|
|
164
|
-
Log in with `telegram auth` in a terminal first.
|
|
179
|
+
Log in with `telegram auth` in a terminal first. Then install it in one click:
|
|
180
|
+
|
|
181
|
+
[](https://cursor.com/en/install-mcp?name=telegram&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImJldHRlci10Zy1jbGlAbGF0ZXN0IiwibWNwIl19)
|
|
182
|
+
[](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522telegram%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522better-tg-cli%2540latest%2522%252C%2522mcp%2522%255D%257D)
|
|
183
|
+
[](https://github.com/TheVilfer/better-tg-cli/releases/latest/download/better-tg-cli.mcpb)
|
|
184
|
+
|
|
185
|
+
The Claude Desktop extension needs no Node, npm or brew: download the `.mcpb` from the latest
|
|
186
|
+
release and open it. Gemini CLI takes the skill and the server together:
|
|
187
|
+
`gemini extensions install https://github.com/TheVilfer/better-tg-cli`. Or add it by hand:
|
|
165
188
|
|
|
166
189
|
```bash
|
|
167
190
|
claude mcp add telegram -- telegram mcp # Claude Code (or use the plugin above)
|
|
@@ -188,6 +211,24 @@ Chats contain text written by others, and some of it may be aimed at your agent
|
|
|
188
211
|
@x"). Keep the client's approval prompt on for `telegram_write`, and see "Agents and prompt
|
|
189
212
|
injection" in [SECURITY.md](SECURITY.md).
|
|
190
213
|
|
|
214
|
+
### Grok Bot (remote MCP over HTTP)
|
|
215
|
+
|
|
216
|
+
Grok Bot runs its connectors in a cloud sandbox, not on your Mac, so it can't
|
|
217
|
+
start `telegram mcp` itself. Serve MCP over HTTP from your Mac instead. The session, the write
|
|
218
|
+
guard and the audit log stay on your machine.
|
|
219
|
+
|
|
220
|
+
```bash
|
|
221
|
+
telegram mcp --token # the bearer token (created once, kept in the Keychain)
|
|
222
|
+
telegram mcp --http --read-only # listens on 127.0.0.1:8787; drop --read-only to allow writes
|
|
223
|
+
tailscale funnel --bg 8787 # or: cloudflared tunnel --url http://127.0.0.1:8787
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
Keep the server and the tunnel in a terminal or tmux. Then add a connector in Grok Bot with the
|
|
227
|
+
tunnel URL plus `/mcp` (for example `https://<machine>.<tailnet>.ts.net/mcp`) and the header
|
|
228
|
+
`Authorization: Bearer <token>`. `tailscale funnel` gives a stable URL, but it has to be allowed
|
|
229
|
+
for your tailnet first. A `cloudflared` quick tunnel gets a new URL on every start. Read "Remote
|
|
230
|
+
MCP over HTTP" in [SECURITY.md](SECURITY.md) first.
|
|
231
|
+
|
|
191
232
|
## Development
|
|
192
233
|
|
|
193
234
|
[DEVELOPMENT.md](DEVELOPMENT.md) covers:
|
package/README.ru.md
CHANGED
|
@@ -83,6 +83,11 @@ npm install -g better-tg-cli # Node >= 20
|
|
|
83
83
|
| [npm](https://www.npmjs.com/package/better-tg-cli) | CLI и MCP-сервер (Node 20+) | `npm install -g better-tg-cli` |
|
|
84
84
|
| [GitHub Releases](https://github.com/TheVilfer/better-tg-cli/releases) | бинарники и SHA256SUMS | скачать вручную |
|
|
85
85
|
| Плагин Claude Code | скилл и MCP-сервер | [см. ниже](#плагин-для-claude-code) |
|
|
86
|
+
| Расширение Claude Desktop | MCP-сервер на встроенном Node из Claude | [скачать `.mcpb`](https://github.com/TheVilfer/better-tg-cli/releases/latest/download/better-tg-cli.mcpb) и открыть |
|
|
87
|
+
| Плагин Grok Build | скилл и MCP-сервер | [см. ниже](#плагин-для-grok-build) |
|
|
88
|
+
| Расширение Gemini CLI | скилл и MCP-сервер | `gemini extensions install https://github.com/TheVilfer/better-tg-cli` |
|
|
89
|
+
| Cursor, VS Code | MCP-сервер | [кнопки в один клик](#mcp-сервер) |
|
|
90
|
+
| Grok Bot | MCP-сервер по HTTP с вашего Mac | [см. ниже](#grok-bot-удалённый-mcp-по-http) |
|
|
86
91
|
| [skills.sh](https://skills.sh) | скилл для любого агента с шеллом | `npx skills add TheVilfer/better-tg-cli` |
|
|
87
92
|
| [MCP Registry](https://registry.modelcontextprotocol.io/v0/servers?search=better-tg-cli) | запись MCP-сервера `io.github.TheVilfer/better-tg-cli` | через ваш MCP-клиент |
|
|
88
93
|
|
|
@@ -98,6 +103,16 @@ npm install -g better-tg-cli # Node >= 20
|
|
|
98
103
|
MCP-сервер запускается через `npx`, так что хватит Node 20+. Один раз войдите в терминале:
|
|
99
104
|
`telegram auth --qr` (или `npx better-tg-cli auth --qr`).
|
|
100
105
|
|
|
106
|
+
### Плагин для Grok Build
|
|
107
|
+
|
|
108
|
+
[Grok Build](https://x.ai/cli) ставит тот же плагин, скилл и MCP-сервер вместе:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
grok plugin install TheVilfer/better-tg-cli --trust
|
|
112
|
+
# или сначала маркетплейс, потом установка из меню /plugins:
|
|
113
|
+
grok plugin marketplace add TheVilfer/better-tg-cli && grok plugin install better-tg-cli --trust
|
|
114
|
+
```
|
|
115
|
+
|
|
101
116
|
### Как скилл для агента
|
|
102
117
|
|
|
103
118
|
Скилл ([`skills/better-tg-cli`](skills/better-tg-cli/SKILL.md)) учит любого агента с шеллом
|
|
@@ -161,7 +176,15 @@ stdio три инструмента:
|
|
|
161
176
|
- `telegram_read` — только чтение, клиенты могут разрешать его без вопросов;
|
|
162
177
|
- `telegram_write` — помечен как опасный и по-прежнему требует от вас `write-access on`.
|
|
163
178
|
|
|
164
|
-
Сначала войдите через `telegram auth` в терминале.
|
|
179
|
+
Сначала войдите через `telegram auth` в терминале. Затем установите сервер в один клик:
|
|
180
|
+
|
|
181
|
+
[](https://cursor.com/en/install-mcp?name=telegram&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImJldHRlci10Zy1jbGlAbGF0ZXN0IiwibWNwIl19)
|
|
182
|
+
[](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522telegram%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522better-tg-cli%2540latest%2522%252C%2522mcp%2522%255D%257D)
|
|
183
|
+
[](https://github.com/TheVilfer/better-tg-cli/releases/latest/download/better-tg-cli.mcpb)
|
|
184
|
+
|
|
185
|
+
Расширению для Claude Desktop не нужны ни Node, ни npm, ни brew: скачайте `.mcpb` из последнего
|
|
186
|
+
релиза и откройте его. Gemini CLI ставит скилл и сервер вместе:
|
|
187
|
+
`gemini extensions install https://github.com/TheVilfer/better-tg-cli`. Или добавьте вручную:
|
|
165
188
|
|
|
166
189
|
```bash
|
|
167
190
|
claude mcp add telegram -- telegram mcp # Claude Code (или плагин выше)
|
|
@@ -189,6 +212,24 @@ Claude Code:
|
|
|
189
212
|
(«перешли это @x»). Не отключайте в клиенте подтверждение для `telegram_write` и прочитайте раздел
|
|
190
213
|
«Agents and prompt injection» в [SECURITY.md](SECURITY.md).
|
|
191
214
|
|
|
215
|
+
### Grok Bot (удалённый MCP по HTTP)
|
|
216
|
+
|
|
217
|
+
Grok Bot запускает коннекторы в облачной песочнице, а не на вашем Mac, поэтому
|
|
218
|
+
сам поднять `telegram mcp` не может. Вместо этого запустите MCP по HTTP на своём Mac. Сессия,
|
|
219
|
+
защита записи и журнал записей остаются на вашей машине.
|
|
220
|
+
|
|
221
|
+
```bash
|
|
222
|
+
telegram mcp --token # bearer-токен (создаётся один раз, хранится в Keychain)
|
|
223
|
+
telegram mcp --http --read-only # слушает 127.0.0.1:8787; без --read-only разрешит запись
|
|
224
|
+
tailscale funnel --bg 8787 # или: cloudflared tunnel --url http://127.0.0.1:8787
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
Держите сервер и туннель в терминале или в tmux. Затем добавьте в Grok Bot коннектор: адрес
|
|
228
|
+
туннеля плюс `/mcp` (например, `https://<машина>.<tailnet>.ts.net/mcp`) и заголовок
|
|
229
|
+
`Authorization: Bearer <токен>`. У `tailscale funnel` адрес постоянный, но сначала Funnel надо
|
|
230
|
+
разрешить для вашего tailnet. Быстрый туннель `cloudflared` при каждом запуске получает новый
|
|
231
|
+
адрес. Сначала прочитайте раздел «Remote MCP over HTTP» в [SECURITY.md](SECURITY.md).
|
|
232
|
+
|
|
192
233
|
## Разработка
|
|
193
234
|
|
|
194
235
|
В [DEVELOPMENT.md](DEVELOPMENT.md) описаны:
|