omnikey-cli 1.5.3 → 1.5.5

package/README.md

@@ -21,6 +21,7 @@ OmnikeyAI is a productivity tool that helps you quickly rewrite selected text us
 - `omnikey grant-browser-access`: One-time setup to give Omnikey access to authenticated browser tabs for web fetch.
 - Scheduled Jobs commands to create, list, delete, and trigger jobs from the CLI.
 - `omnikey mcp`: manage MCP (Model Context Protocol) servers available to the agent (stdio, HTTP, SSE transports).
+- `omnikey telegram`: run the Telegram client as a persistent background daemon — receive Omnikey notifications in your Telegram chat and interact with the agent from your phone.
 
 ## Usage
 
@@ -93,6 +94,24 @@ omnikey mcp toggle <id>
 
 # Edit an MCP server by ID (interactive, current values as defaults)
 omnikey mcp update <id>
+
+# Install and start the Telegram bot daemon (prompts for credentials on first run)
+omnikey telegram start
+
+# Stop the Telegram bot daemon
+omnikey telegram stop
+
+# Restart the Telegram bot daemon
+omnikey telegram restart
+
+# Show daemon status (launchd/NSSM info + port check)
+omnikey telegram status
+
+# Tail the Telegram bot daemon logs
+omnikey telegram logs
+
+# Stop and fully remove the Telegram bot daemon
+omnikey telegram uninstall
 ```
 
 ### Command reference
@@ -119,6 +138,12 @@ omnikey mcp update <id>
 | `omnikey mcp remove`                  | Remove an MCP server via interactive selection and confirmation            |
 | `omnikey mcp toggle <id>`             | Enable or disable an MCP server by ID                                     |
 | `omnikey mcp update <id>`             | Edit an MCP server by ID (interactive, current values as defaults)        |
+| `omnikey telegram start`              | Install and start the Telegram bot daemon (prompts for credentials)       |
+| `omnikey telegram stop`               | Stop the Telegram bot daemon                                              |
+| `omnikey telegram restart`            | Restart the Telegram bot daemon                                           |
+| `omnikey telegram status`             | Show daemon status (launchd/NSSM info + port check)                       |
+| `omnikey telegram logs`               | Tail the Telegram bot daemon logs                                         |
+| `omnikey telegram uninstall`          | Stop and fully remove the Telegram bot daemon                             |
 
 ## Scheduled Jobs
 
@@ -231,6 +256,45 @@ The CLI automatically enables **"Allow JavaScript from Apple Events"** for every
 
 Both changes are permanent and survive reboots. Restart each browser once after setup for the change to take effect.
 
+## Telegram Bot Daemon
+
+The `omnikey telegram` command group runs a Telegram bot as a persistent background service. Once started, the bot sends Omnikey notifications to your Telegram chat and lets you interact with the agent directly from your phone.
+
+For setup instructions (creating a bot, finding your chat ID, and configuring credentials) see the [Telegram README](../telegram/README.md).
+
+### `omnikey telegram start`
+
+Installs and starts the daemon. If `TELEGRAM_BOT_TOKEN` or `TELEGRAM_CHAT_ID` are not yet saved, the CLI prompts for them, validates the token against the Telegram API, and saves them to `~/.omnikey/config.json` before installing the service. On macOS the bot runs as a **launchd agent**; on Windows as an **NSSM service**. Both auto-restart on crash and start automatically on login.
+
+### `omnikey telegram stop`
+
+Unloads the launchd agent (macOS) or stops the NSSM service (Windows). The service definition is kept so `omnikey telegram start` can bring it back without re-entering credentials.
+
+### `omnikey telegram restart`
+
+Equivalent to `stop` followed by `start`. Useful after updating credentials or rotating the bot token.
+
+### `omnikey telegram status`
+
+Prints:
+
+- Path to the service definition (plist on macOS, service name on Windows)
+- Current launchd / NSSM status including the running PID
+- Whether anything is listening on the bot's HTTP port (default `6666`)
+
+### `omnikey telegram logs`
+
+Tails the last 100 lines of both stdout and stderr logs and follows new output (Ctrl-C to stop).
+
+| Platform | Log files |
+| -------- | --------- |
+| macOS    | `~/Library/Logs/telegram/out.log`, `~/Library/Logs/telegram/err.log` |
+| Windows  | `~/.omnikey/telegram/daemon.log`, `~/.omnikey/telegram/daemon-error.log` |
+
+### `omnikey telegram uninstall`
+
+Stops the daemon and removes the service definition entirely. Run `omnikey telegram start` to reinstall from scratch.
+
 ## Platform notes
 
 ### macOS

package/dist/index.js

@@ -13,11 +13,12 @@ const setConfig_1 = require("./setConfig");
 const grantBrowserAccess_1 = require("./grantBrowserAccess");
 const scheduleJob_1 = require("./scheduleJob");
 const mcpServer_1 = require("./mcpServer");
+const telegramDaemon_1 = require("./telegramDaemon");
 const program = new commander_1.Command();
 program
     .name('omnikey')
     .description('Omnikey CLI for onboarding and configuration')
-    .version('1.0.0');
+    .version('1.5.4');
 program
     .command('onboard')
     .description('Onboard and configure your AI provider')
@@ -28,9 +29,13 @@ program
     .command('daemon')
     .description('Start the Omnikey API backend as a daemon on a specified port')
     .option('--port <port>', 'Port to run the backend on', '7071')
+    .option('--telegram', 'Also install and start the Telegram bot daemon')
     .action(async (options) => {
     const port = Number(options.port) || 7071;
     await (0, daemon_1.startDaemon)(port);
+    if (options.telegram) {
+        await (0, telegramDaemon_1.startTelegramDaemon)();
+    }
 });
 program
     .command('kill-daemon')
@@ -77,10 +82,14 @@ program
     .command('restart-daemon')
     .description('Restart the Omnikey API backend daemon')
     .option('--port <port>', 'Port to run the backend on', '7071')
+    .option('--telegram', 'Also restart the Telegram bot daemon')
     .action(async (options) => {
     (0, killDaemon_1.killDaemon)();
     const port = Number(options.port) || 7071;
     await (0, daemon_1.startDaemon)(port);
+    if (options.telegram) {
+        await (0, telegramDaemon_1.restartTelegramDaemon)();
+    }
 });
 program
     .command('grant-browser-access')
@@ -154,4 +163,44 @@ mcpCmd
     .action(async (id) => {
     await (0, mcpServer_1.mcpUpdate)(id);
 });
+const telegramDaemonCmd = program
+    .command('telegram')
+    .description('Manage the Telegram bot daemon (launchd on macOS, NSSM on Windows). ' +
+    'Run `omnikey telegram start` to install and start.');
+telegramDaemonCmd
+    .command('start')
+    .description('Install and start the Telegram bot daemon (survives reboots, auto-restarts)')
+    .action(async () => {
+    await (0, telegramDaemon_1.startTelegramDaemon)();
+});
+telegramDaemonCmd
+    .command('stop')
+    .description('Stop the Telegram bot daemon')
+    .action(() => {
+    (0, telegramDaemon_1.stopTelegramDaemon)();
+});
+telegramDaemonCmd
+    .command('restart')
+    .description('Restart the Telegram bot daemon')
+    .action(async () => {
+    await (0, telegramDaemon_1.restartTelegramDaemon)();
+});
+telegramDaemonCmd
+    .command('status')
+    .description('Show the current status of the Telegram bot daemon')
+    .action(() => {
+    (0, telegramDaemon_1.statusTelegramDaemon)();
+});
+telegramDaemonCmd
+    .command('logs')
+    .description('Tail the Telegram bot daemon logs')
+    .action(() => {
+    (0, telegramDaemon_1.logsTelegramDaemon)();
+});
+telegramDaemonCmd
+    .command('uninstall')
+    .description('Stop and remove the Telegram bot daemon')
+    .action(() => {
+    (0, telegramDaemon_1.uninstallTelegramDaemon)();
+});
 program.parseAsync(process.argv);

package/dist/telegramClient.js

@@ -0,0 +1,188 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureTelegramConfig = ensureTelegramConfig;
+exports.spawnTelegramClient = spawnTelegramClient;
+exports.startTelegramClientCommand = startTelegramClientCommand;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const child_process_1 = require("child_process");
+const https_1 = require("https");
+const inquirer_1 = __importDefault(require("inquirer"));
+const utils_1 = require("./utils");
+const REQUIRED_ENV_KEYS = ['TELEGRAM_BOT_TOKEN', 'TELEGRAM_CHAT_ID'];
+/**
+ * Where the bundled bot lives at runtime. The CLI's `build:telegram-client`
+ * script populates this directory with the bot's compiled output plus its
+ * production `node_modules`.
+ */
+function resolveBundleRoot() {
+    // dist/telegramClient.js → ../telegram-client-dist
+    return path_1.default.resolve(__dirname, '..', 'telegram-client-dist');
+}
+function resolveBundledEntry() {
+    return path_1.default.join(resolveBundleRoot(), 'dist', 'index.js');
+}
+function persistConfig(values) {
+    const configDir = (0, utils_1.getConfigDir)();
+    const configPath = (0, utils_1.getConfigPath)();
+    const existing = (0, utils_1.readConfig)();
+    const merged = { ...existing, ...values };
+    fs_1.default.mkdirSync(configDir, { recursive: true });
+    fs_1.default.writeFileSync(configPath, JSON.stringify(merged, null, 2), 'utf-8');
+}
+/**
+ * Verify a Telegram bot token via the Bot API's getMe endpoint.
+ * Resolves to the bot's @username on success, throws on failure.
+ */
+function verifyToken(token) {
+    return new Promise((resolve, reject) => {
+        const req = (0, https_1.request)({
+            method: 'GET',
+            hostname: 'api.telegram.org',
+            path: `/bot${token}/getMe`,
+        }, (res) => {
+            let body = '';
+            res.on('data', (chunk) => (body += chunk));
+            res.on('end', () => {
+                try {
+                    const parsed = JSON.parse(body);
+                    if (!parsed.ok) {
+                        reject(new Error(parsed.description || 'Telegram rejected the token'));
+                        return;
+                    }
+                    resolve(parsed.result?.username || 'bot');
+                }
+                catch (err) {
+                    reject(new Error(`Invalid JSON from Telegram: ${body}`));
+                }
+            });
+        });
+        req.on('error', reject);
+        req.end();
+    });
+}
+/**
+ * Ensure TELEGRAM_BOT_TOKEN and TELEGRAM_CHAT_ID are present in
+ * ~/.omnikey/config.json. Prompts for any missing values (unless
+ * `nonInteractive` is set) and validates the token against the Bot API.
+ *
+ * Returns the resolved config values (existing or newly captured).
+ */
+async function ensureTelegramConfig(options = {}) {
+    const existing = (0, utils_1.readConfig)();
+    const resolved = {};
+    const missing = [];
+    for (const key of REQUIRED_ENV_KEYS) {
+        const value = existing[key];
+        if (typeof value === 'string' && value.trim() !== '') {
+            resolved[key] = value.trim();
+        }
+        else {
+            missing.push(key);
+        }
+    }
+    if (missing.length === 0) {
+        return resolved;
+    }
+    if (options.nonInteractive) {
+        throw new Error(`Missing required Telegram config in ${(0, utils_1.getConfigPath)()}: ${missing.join(', ')}`);
+    }
+    console.log('\nTelegram client configuration required.');
+    console.log('See telegram/README.md for how to create a bot with @BotFather and find your chat id.\n');
+    const toPersist = {};
+    if (missing.includes('TELEGRAM_BOT_TOKEN')) {
+        const { token } = await inquirer_1.default.prompt([
+            {
+                type: 'password',
+                name: 'token',
+                mask: '*',
+                message: 'Enter your Telegram bot token (from @BotFather):',
+                validate: (input) => /^\d+:[A-Za-z0-9_-]{20,}$/.test(input.trim()) ||
+                    'Token should look like 123456789:ABC... (digits, colon, 20+ chars)',
+            },
+        ]);
+        try {
+            const username = await verifyToken(token.trim());
+            console.log(`Token validated for @${username}.`);
+        }
+        catch (err) {
+            throw new Error(`Telegram rejected the token: ${err instanceof Error ? err.message : String(err)}`);
+        }
+        resolved.TELEGRAM_BOT_TOKEN = token.trim();
+        toPersist.TELEGRAM_BOT_TOKEN = token.trim();
+    }
+    if (missing.includes('TELEGRAM_CHAT_ID')) {
+        const { chatId } = await inquirer_1.default.prompt([
+            {
+                type: 'input',
+                name: 'chatId',
+                message: 'Enter the chat id to receive notifications (curl https://api.telegram.org/bot<token>/getUpdates):',
+                validate: (input) => /^-?\d+$/.test(input.trim()) || 'Chat id must be a numeric value (groups are negative)',
+            },
+        ]);
+        resolved.TELEGRAM_CHAT_ID = chatId.trim();
+        toPersist.TELEGRAM_CHAT_ID = chatId.trim();
+    }
+    if (Object.keys(toPersist).length > 0) {
+        persistConfig(toPersist);
+        console.log(`Saved Telegram config to ${(0, utils_1.getConfigPath)()}.`);
+    }
+    return resolved;
+}
+/**
+ * Spawn the bundled telegram-bot server as a long-lived child process.
+ * The bot reads PORT from process.env (defaults to 7072 in the app), so we
+ * inject the CLI's chosen port that way to keep the upstream code untouched.
+ */
+function spawnTelegramClient(port, env) {
+    const bundleRoot = resolveBundleRoot();
+    const entry = resolveBundledEntry();
+    if (!fs_1.default.existsSync(entry)) {
+        throw new Error(`Bundled telegram-client not found at ${entry}. ` +
+            'Reinstall omnikey-cli or run `npm run build` from the cli/ directory.');
+    }
+    const configDir = (0, utils_1.getConfigDir)();
+    fs_1.default.mkdirSync(configDir, { recursive: true });
+    const logPath = path_1.default.join(configDir, 'telegram-client.log');
+    const errorLogPath = path_1.default.join(configDir, 'telegram-client-error.log');
+    const { out, err } = (0, utils_1.initLogFiles)(logPath, errorLogPath);
+    const child = (0, child_process_1.spawn)(process.execPath, [entry], {
+        detached: false,
+        stdio: ['ignore', out, err],
+        // cwd = bundle root so the bot's dotenv.config() and relative paths line up
+        cwd: bundleRoot,
+        env: {
+            ...process.env,
+            ...env,
+            PORT: String(port),
+        },
+    });
+    child.on('exit', (code, signal) => {
+        fs_1.default.closeSync(out);
+        fs_1.default.closeSync(err);
+        if (code !== 0) {
+            console.error(`telegram-client exited with code=${code} signal=${signal ?? 'none'}`);
+        }
+    });
+    return child;
+}
+/** Top-level command: `omnikey telegram-client [--port <port>]`. */
+async function startTelegramClientCommand(port) {
+    const cfg = await ensureTelegramConfig();
+    const child = spawnTelegramClient(port, cfg);
+    console.log(`telegram-client started (pid=${child.pid}) on port ${port}. ` +
+        `Logs: ${path_1.default.join((0, utils_1.getConfigDir)(), 'telegram-client.log')}`);
+    // Keep the CLI process alive until the child exits so users can Ctrl+C.
+    await new Promise((resolve) => {
+        child.on('exit', () => resolve());
+        process.on('SIGINT', () => {
+            child.kill('SIGINT');
+        });
+        process.on('SIGTERM', () => {
+            child.kill('SIGTERM');
+        });
+    });
+}