@mrciphersmith/keryx 0.3.48 → 0.3.51

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.
Files changed (4) hide show
  1. package/README.md +12 -6
  2. package/dist/cli.js +6890 -4481
  3. package/dist/core.js +208 -92
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -1005,17 +1005,23 @@ setup.
1005
1005
  `/remote-control` in a running shell mirrors that session into its own topic of a
1006
1006
  Telegram supergroup: you send a line from your phone and it runs as if typed
1007
1007
  there, the reply and any approval question come back to the topic. Nothing
1008
- happens until you set three things up: a separate bot made with BotFather, its
1009
- token in `remote/bot-token` in the global keryx directory with mode 600; the
1010
- Telegram user id that may use it, in the allowlist file `remote/config.json`; and
1011
- a supergroup with topics enabled where that bot is an admin with the manage topics
1012
- right. The Telegram transport is the single poller inside `keryx serve` — shells
1008
+ happens until Telegram is connected to the machine: make a separate bot with
1009
+ BotFather and a supergroup with topics, then type `/channels` in any shell and
1010
+ choose Connect. The only thing you type is the bot token (hidden); your Telegram
1011
+ user id and the group id are found from a one-time pairing code and from adding
1012
+ the bot to the group as an admin with the manage topics right. Test sends a
1013
+ message to the group's General topic, Disconnect deletes the topics and erases the
1014
+ token. The connection is per machine, so use one bot per machine (Telegram allows
1015
+ one poller per token); `/remote-control` then turns individual sessions on. The
1016
+ files it writes, `remote/bot-token` (mode 600) and `remote/config.json`, can still
1017
+ be made by hand. The Telegram transport is the single poller inside `keryx serve` — shells
1013
1018
  talk to `serve` over loopback with a local shell token (new on every `serve`
1014
1019
  start, and never sent to an endpoint whose `serve` is gone), they never poll
1015
1020
  Telegram themselves, and a second `keryx serve` does not poll while the first one
1016
1021
  runs. At most 500 lines wait per topic, and turning it off tells the topic which
1017
1022
  queued lines will not run.
1018
- Without the config files `serve` starts as before, with remote control off. This
1023
+ Without a connection `serve` starts as before, with remote control off, and only
1024
+ offers the local `/channels` routes. This
1019
1025
  has been verified against a fake Bot API only; no run against real Telegram has
1020
1026
  been done yet. Setup and limits:
1021
1027
  [drive keryx remotely](docs/docs/guides/drive-keryx-remotely.md#remote-control-from-telegram).