better-tg-cli 0.27.0 → 0.29.0

package/README.md

@@ -66,9 +66,18 @@ A fork of [skillhq/telegram](https://github.com/skillhq/telegram), reworked for
 
 ```bash
 brew install thevilfer/tap/better-tg-cli   # standalone binary, macOS and Linux
-npm install -g better-tg-cli               # Node >= 20
+npm install -g better-tg-cli               # Node >= 20, any OS
 ```
 
+On Windows (experimental), with [Scoop](https://scoop.sh) or npm:
+
+```powershell
+scoop bucket add thevilfer https://github.com/TheVilfer/scoop-bucket
+scoop install better-tg-cli
+```
+
+The Windows `telegram.exe` is not code-signed, so SmartScreen may warn about the release download.
+
 `telegram update` upgrades an existing install, whichever of these you used. On a terminal the CLI
 checks for new versions once a day. Agents and pipes never see that notice, and
 `TG_NO_UPDATE_CHECK=1` turns it off.
@@ -84,6 +93,7 @@ Every channel ships the same version from one release:
 |---|---|---|
 | [Homebrew](https://github.com/TheVilfer/homebrew-tap) | standalone binary | `brew install thevilfer/tap/better-tg-cli` |
 | [npm](https://www.npmjs.com/package/better-tg-cli) | CLI and MCP server (Node 20+) | `npm install -g better-tg-cli` |
+| [Scoop](https://github.com/TheVilfer/scoop-bucket) (Windows, experimental) | standalone `telegram.exe` | `scoop bucket add thevilfer https://github.com/TheVilfer/scoop-bucket` then `scoop install better-tg-cli` |
 | [GitHub Releases](https://github.com/TheVilfer/better-tg-cli/releases) | binaries and SHA256SUMS | download by hand |
 | Claude Code plugin | skill and MCP server | [see below](#claude-code-plugin) |
 | 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 |
@@ -107,6 +117,15 @@ The skill and the MCP server together, in one install:
 It runs the MCP server through `npx`, so Node 20+ is enough. Log in once with `telegram auth --qr`
 (or `npx better-tg-cli auth --qr`) in a terminal.
 
+### Codex plugin
+
+The same skill and MCP server as a Codex plugin (also shows up in the ChatGPT desktop app):
+
+```bash
+codex plugin marketplace add TheVilfer/better-tg-cli
+codex plugin add better-tg-cli@better-tg-cli
+```
+
 ### Grok Build plugin
 
 [Grok Build](https://x.ai/cli) installs the same plugin, skill and MCP server together:
@@ -167,7 +186,9 @@ The session is stored in the macOS Keychain (service `tg-cli`), or in 1Password
 Keyring, KWallet, KeePassXC) through `secret-tool`, which needs the `libsecret-tools` package. A
 session already saved in the config file moves there automatically. Without any secret store, the
 session is kept in `~/.config/tg/config.json5` (mode 0600) and write commands stay disabled.
-On Linux, `write-access on` is confirmed at a terminal prompt.
+On Linux, `write-access on` is confirmed at a terminal prompt. On Windows the secrets live in
+`%APPDATA%\tg\secrets.dpapi`, encrypted with DPAPI for your Windows user (only you on this machine
+can decrypt it), and `write-access on` asks in a Yes/No window when there's no terminal.
 
 ## Usage
 
@@ -276,7 +297,9 @@ The session is in the macOS Keychain, the Linux Secret Service or 1Password. The
 Yes, with `TG_PROFILE`: each profile has its own login, config and Keychain items, for example `TG_PROFILE=work telegram auth --qr`. Switching accounts properly is tracked in [#5](https://github.com/TheVilfer/better-tg-cli/issues/5).
 
 **Does it work on Windows?**
-Not yet. It is built and tested on macOS and Linux, and relies on their secret stores.
+Yes, experimentally: `scoop install better-tg-cli` or npm. Secrets are stored with Windows DPAPI
+and CI runs the tests on Windows, but live use there is less tested than on macOS and Linux. Please
+report problems in the issues.
 
 **Can I use it from Grok Bot, ChatGPT or another cloud agent?**
 Cloud agents can't start a program on your computer, so run the MCP server over HTTP and reach it through a tunnel. See [Grok Bot](#grok-bot-remote-mcp-over-http).
@@ -293,17 +316,43 @@ If you installed the agent skill with `telegram skill install`, run that again t
 - Telegram test servers;
 - editor debugging and tests.
 
-Releases are cut by `scripts/release.sh patch|minor|major`. A tag builds the binaries and
+Releases are cut by `scripts/release.sh patch|minor|major` (a release PR), then `scripts/release.sh tag` after the merge. A tag builds the binaries and
 publishes to GitHub Releases, npm (trusted publishing with provenance), the Homebrew tap and the
 MCP Registry. See
 [CONTRIBUTING.md](CONTRIBUTING.md).
 
+## Uninstall
+
+1. `telegram logout` deletes the saved session. To end it on Telegram's side too, terminate it in
+   Telegram → Settings → Devices.
+2. `telegram skill uninstall` removes the skill from the agents it was installed into.
+3. Remove the program: `brew uninstall better-tg-cli`, `npm uninstall -g better-tg-cli` or
+   `scoop uninstall better-tg-cli`. For a binary from Releases, delete `telegram` / `telegram.exe`.
+4. Delete the config folder: `~/.config/tg` (`%APPDATA%\tg` on Windows), plus `~/.config/tg-<profile>`
+   for any `TG_PROFILE` you used. On Windows this also removes the DPAPI secrets file. Elsewhere the
+   api_hash and write-access flag stay in the secret store: delete the `tg-cli` items in Keychain
+   Access (or `secret-tool clear service tg-cli`), or the item in your 1Password vault.
+
 ## Privacy
 
 No analytics. The only service we run is the optional invite broker, which never sees your
 messages or session. See [PRIVACY.md](PRIVACY.md) for the three hosts the CLI talks to and what it
 stores locally.
 
+## Code signing policy
+
+Windows binaries are built from this repository by GitHub Actions only (`.github/workflows/release.yml`),
+never on a personal machine. We have applied for free code signing from SignPath Foundation; once it
+is in place, release binaries will carry: *Free code signing provided by
+[SignPath.io](https://about.signpath.io), certificate by [SignPath Foundation](https://signpath.org).*
+Until then the Windows `telegram.exe` is unsigned; macOS binaries are ad-hoc signed.
+
+- Committers and reviewers: [@TheVilfer](https://github.com/TheVilfer)
+- Approvers (each signed release): [@TheVilfer](https://github.com/TheVilfer)
+- Privacy policy: [PRIVACY.md](PRIVACY.md). The CLI talks only to Telegram, to the invite broker
+  when you log in with an invite, and to the npm registry for a daily update check in a terminal
+  (off with `TG_NO_UPDATE_CHECK=1`).
+
 ## License
 
 MIT, see [LICENSE](LICENSE). Based on [skillhq/telegram](https://github.com/skillhq/telegram) by

package/README.ru.md

@@ -65,9 +65,18 @@ $ telegram inbox -n 3
 
 ```bash
 brew install thevilfer/tap/better-tg-cli   # отдельный бинарник, macOS и Linux
-npm install -g better-tg-cli               # Node >= 20
+npm install -g better-tg-cli               # Node >= 20, любая ОС
 ```
 
+На Windows (экспериментально) через [Scoop](https://scoop.sh) или npm:
+
+```powershell
+scoop bucket add thevilfer https://github.com/TheVilfer/scoop-bucket
+scoop install better-tg-cli
+```
+
+`telegram.exe` для Windows не подписан, поэтому SmartScreen может предупредить при скачивании из релиза.
+
 `telegram update` обновляет CLI тем же способом, каким он был установлен. В терминале CLI раз в
 сутки проверяет, не вышла ли новая версия. Агенты и пайпы этого уведомления не видят, а
 `TG_NO_UPDATE_CHECK=1` отключает его совсем.
@@ -83,6 +92,7 @@ npm install -g better-tg-cli               # Node >= 20
 |---|---|---|
 | [Homebrew](https://github.com/TheVilfer/homebrew-tap) | отдельный бинарник | `brew install thevilfer/tap/better-tg-cli` |
 | [npm](https://www.npmjs.com/package/better-tg-cli) | CLI и MCP-сервер (Node 20+) | `npm install -g better-tg-cli` |
+| [Scoop](https://github.com/TheVilfer/scoop-bucket) (Windows, экспериментально) | отдельный `telegram.exe` | `scoop bucket add thevilfer https://github.com/TheVilfer/scoop-bucket`, затем `scoop install better-tg-cli` |
 | [GitHub Releases](https://github.com/TheVilfer/better-tg-cli/releases) | бинарники и SHA256SUMS | скачать вручную |
 | Плагин Claude Code | скилл и MCP-сервер | [см. ниже](#плагин-для-claude-code) |
 | Расширение Claude Desktop | MCP-сервер на встроенном Node из Claude | [скачать `.mcpb`](https://github.com/TheVilfer/better-tg-cli/releases/latest/download/better-tg-cli.mcpb) и открыть |
@@ -106,6 +116,15 @@ npm install -g better-tg-cli               # Node >= 20
 MCP-сервер запускается через `npx`, так что хватит Node 20+. Один раз войдите в терминале:
 `telegram auth --qr` (или `npx better-tg-cli auth --qr`).
 
+### Плагин для Codex
+
+Тот же скилл и MCP-сервер в виде плагина Codex (он появится и в десктопном приложении ChatGPT):
+
+```bash
+codex plugin marketplace add TheVilfer/better-tg-cli
+codex plugin add better-tg-cli@better-tg-cli
+```
+
 ### Плагин для Grok Build
 
 [Grok Build](https://x.ai/cli) ставит тот же плагин, скилл и MCP-сервер вместе:
@@ -167,7 +186,9 @@ npx skills add TheVilfer/better-tg-cli -g -a claude-code -a codex -y
 KeePassXC) через `secret-tool`, для этого нужен пакет `libsecret-tools`. Сессия, которая уже лежит
 в конфиге, переедет туда сама. Если хранилища секретов нет, сессия лежит в
 `~/.config/tg/config.json5` (права 0600), а запись остаётся выключенной. На Linux
-`write-access on` подтверждается в терминале.
+`write-access on` подтверждается в терминале. На Windows секреты лежат в
+`%APPDATA%\tg\secrets.dpapi`, зашифрованные DPAPI для вашего пользователя Windows (расшифровать их
+можете только вы на этой машине), а `write-access on` без терминала спрашивает в окне «Да/Нет».
 
 ## Использование
 
@@ -277,7 +298,9 @@ tailscale funnel --bg 8787                  # или: cloudflared tunnel --url h
 Да, через `TG_PROFILE`: у каждого профиля свой вход, конфиг и записи в Keychain, например `TG_PROFILE=work telegram auth --qr`. Удобное переключение аккаунтов — в [#5](https://github.com/TheVilfer/better-tg-cli/issues/5).
 
 **Работает ли на Windows?**
-Пока нет. CLI собирается и проверяется на macOS и Linux и опирается на их хранилища секретов.
+Да, экспериментально: `scoop install better-tg-cli` или npm. Секреты хранятся через Windows DPAPI,
+тесты гоняются на Windows в CI, но вживую там проверено меньше, чем на macOS и Linux. О проблемах
+пишите в issues.
 
 **Можно ли пользоваться из Grok Bot, ChatGPT или другого облачного агента?**
 Облачный агент не может запустить программу на вашем компьютере, поэтому поднимите MCP-сервер по HTTP и откройте к нему туннель. См. [Grok Bot](#grok-bot-удалённый-mcp-по-http).
@@ -294,16 +317,42 @@ tailscale funnel --bg 8787                  # или: cloudflared tunnel --url h
 - тестовые серверы Telegram;
 - отладка в редакторе и тесты.
 
-Релиз выпускает `scripts/release.sh patch|minor|major`. Тег собирает бинарники и публикует их в
+Релиз готовит `scripts/release.sh patch|minor|major` (PR с новой версией), после мержа `scripts/release.sh tag` ставит тег. Тег собирает бинарники и публикует их в
 GitHub Releases, в npm (trusted publishing с provenance), в Homebrew-тап и в MCP Registry. Подробнее в
 [CONTRIBUTING.md](CONTRIBUTING.md).
 
+## Удаление
+
+1. `telegram logout` удаляет сохранённую сессию. Чтобы завершить её и на стороне Telegram,
+   закройте её в Telegram → Настройки → Устройства.
+2. `telegram skill uninstall` убирает скилл из агентов, куда он был установлен.
+3. Удалите саму программу: `brew uninstall better-tg-cli`, `npm uninstall -g better-tg-cli` или
+   `scoop uninstall better-tg-cli`. Бинарник из Releases удаляется как обычный файл.
+4. Удалите папку настроек: `~/.config/tg` (`%APPDATA%\tg` на Windows) и `~/.config/tg-<профиль>`
+   для каждого `TG_PROFILE`, который вы использовали. На Windows вместе с ней удалится и файл секретов
+   DPAPI. На других системах api_hash и флаг write-access остаются в хранилище секретов: удалите
+   записи `tg-cli` в «Связке ключей» (или `secret-tool clear service tg-cli`) либо запись в 1Password.
+
 ## Приватность
 
 Аналитики нет. Единственный наш сервис — необязательный брокер инвайтов, и он не видит ни ваших
 сообщений, ни сессии. В [PRIVACY.md](PRIVACY.md) перечислены три хоста, с которыми общается CLI,
 и то, что он хранит локально.
 
+## Code signing policy
+
+Бинарники для Windows собираются из этого репозитория только в GitHub Actions
+(`.github/workflows/release.yml`), никогда не на личной машине. Мы подали заявку на бесплатную
+подпись кода от SignPath Foundation; когда её одобрят, в релизах будет: *Free code signing provided
+by [SignPath.io](https://about.signpath.io), certificate by [SignPath Foundation](https://signpath.org).*
+Пока `telegram.exe` для Windows не подписан; бинарники для macOS подписаны ad-hoc.
+
+- Коммиттеры и ревьюеры: [@TheVilfer](https://github.com/TheVilfer)
+- Утверждают каждый подписанный релиз: [@TheVilfer](https://github.com/TheVilfer)
+- Политика приватности: [PRIVACY.md](PRIVACY.md). CLI обращается только к Telegram, к брокеру
+  инвайтов при входе по инвайту и раз в день к npm-реестру за номером версии, если запущен в
+  терминале (отключается `TG_NO_UPDATE_CHECK=1`).
+
 ## Лицензия
 
 MIT, см. [LICENSE](LICENSE). Основано на [skillhq/telegram](https://github.com/skillhq/telegram)