omnikey-cli 1.0.0

package/.github/copilot-instructions.md

@@ -0,0 +1,3 @@
+Work through each checklist item systematically.
+Keep communication concise and focused.
+Follow development best practices.

package/README.md

@@ -0,0 +1,45 @@
+# Omnikey CLI
+
+A command-line tool for onboarding users to the Omnikey open-source app and configuring their OPENAI_API_KEY.
+
+## About OmnikeyAI (macOS)
+
+OmnikeyAI is a productivity tool for macOS that helps you quickly rewrite selected text using OpenAI. It consists of a macOS menu bar app and a TypeScript backend daemon. The CLI allows you to configure and run the backend daemon, onboard users, and manage your OpenAI API key with ease. Once set up, you can select any text on your Mac and trigger rewrite commands directly from your desktop.
+
+- For more details about the app and its features, see the [main README](https://github.com/GurinderRawala/OmniKey-AI).
+- Download the latest macOS app here: [Download OmniKeyAI for macOS](https://omnikeyai-saas-fmytqc3dra-uc.a.run.app/macos/download)
+
+## Features
+
+- `omnikey onboard`: Interactive onboarding to set up your OPENAI_API_KEY.
+- Accepts the `--open-ai-key` parameter for non-interactive setup.
+- Configure and run the backend daemon for the macOS app.
+
+## Usage
+
+```sh
+# Install CLI globally (from this directory)
+npm install -g .
+
+# Onboard interactively (will prompt for OpenAI key and self-hosting)
+omnikey onboard
+
+# Or onboard non-interactively
+omnikey onboard --open-ai-key YOUR_KEY
+
+# Running the daemon will start the backend
+omnikey daemon --port 7071
+
+# Kill the daemon
+omnikey kill-daemon --port 7071
+```
+
+## Development
+
+- Built with Node.js and TypeScript.
+- Uses `commander` for CLI parsing and `inquirer` for prompts.
+- Utilizes Yarn as the package manager.
+
+## License
+
+MIT

package/dist/daemon.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startDaemon = startDaemon;
+const child_process_1 = require("child_process");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+/**
+ * Start the Omnikey API backend as a daemon on the specified port.
+ * @param port The port to run the backend on
+ */
+function startDaemon(port = 8080) {
+    // Only use ~/.omnikey/config.json for environment variables
+    // Path to the backend entry point (now from backend-dist)
+    const backendPath = path_1.default.resolve(__dirname, '../backend-dist/index.js');
+    // Read and update environment variables from ~/.omnikey/config.json
+    const configDir = path_1.default.join(process.env.HOME || process.env.USERPROFILE || '.', '.omnikey');
+    const configPath = path_1.default.join(configDir, 'config.json');
+    let configVars = {};
+    if (fs_1.default.existsSync(configPath)) {
+        try {
+            configVars = JSON.parse(fs_1.default.readFileSync(configPath, 'utf-8'));
+        }
+        catch (e) {
+            console.error('Failed to parse config.json:', e);
+        }
+    }
+    // Ensure both OMNIKEY_PORT and PORT are set for compatibility
+    configVars.OMNIKEY_PORT = port;
+    // Write the updated configVars back to config.json
+    try {
+        fs_1.default.mkdirSync(configDir, { recursive: true });
+        fs_1.default.writeFileSync(configPath, JSON.stringify(configVars, null, 2), 'utf-8');
+    }
+    catch (e) {
+        console.error('Failed to write updated config.json:', e);
+    }
+    // Spawn the backend as a detached child process with env vars from config
+    const child = (0, child_process_1.spawn)('node', [backendPath], {
+        env: { ...process.env, ...configVars, OMNIKEY_PORT: String(port) },
+        detached: true,
+        stdio: 'ignore',
+    });
+    child.unref();
+    console.log(`Omnikey API backend started as a daemon on port ${port}`);
+}

package/dist/index.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const onboard_1 = require("./onboard");
+const daemon_1 = require("./daemon");
+const killDaemon_1 = require("./killDaemon");
+const program = new commander_1.Command();
+program
+    .name('omnikey')
+    .description('Omnikey CLI for onboarding and configuration')
+    .version('1.0.0');
+program
+    .command('onboard')
+    .description('Onboard and configure your OPENAI_API_KEY')
+    .option('--open-ai-key <key>', 'Your OpenAI API Key')
+    .action(async (options) => {
+    await (0, onboard_1.onboard)(options.openAiKey || options.openAiKey || options['open-ai-key']);
+});
+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', '8080')
+    .action((options) => {
+    const port = Number(options.port) || 8080;
+    (0, daemon_1.startDaemon)(port);
+});
+program
+    .command('kill-daemon')
+    .description('Kill the Omnikey API backend daemon running on a specified port')
+    .option('--port <port>', 'Port to look for the daemon on', '8080')
+    .action((options) => {
+    const port = Number(options.port) || 8080;
+    (0, killDaemon_1.killDaemon)(port);
+});
+program.parseAsync(process.argv);

package/dist/killDaemon.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.killDaemon = killDaemon;
+const child_process_1 = require("child_process");
+/**
+ * Kill the Omnikey API backend daemon running on a given port (default 8080).
+ * Looks for node processes running backend-dist/index.js on the specified port and kills them.
+ * @param port The port to look for (default 8080)
+ */
+function killDaemon(port = 8080) {
+    try {
+        // Find the PID(s) of node processes running backend-dist/index.js on the given port
+        // macOS: lsof -i :PORT -t
+        const pids = (0, child_process_1.execSync)(`lsof -i :${port} -t`).toString().split('\n').filter(Boolean);
+        if (pids.length === 0) {
+            console.log(`No daemon found running on port ${port}.`);
+            return;
+        }
+        for (const pid of pids) {
+            try {
+                process.kill(Number(pid), 'SIGTERM');
+                console.log(`Killed daemon process with PID ${pid} on port ${port}.`);
+            }
+            catch (e) {
+                console.error(`Failed to kill process ${pid}:`, e);
+            }
+        }
+    }
+    catch (e) {
+        console.log(`No daemon found running on port ${port}.`);
+    }
+}

package/dist/onboard.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onboard = onboard;
+const inquirer_1 = __importDefault(require("inquirer"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Onboard the user by configuring their OPENAI_API_KEY and generating a .env for self-hosted use.
+ * @param openAiKey Optional key provided via CLI
+ */
+async function onboard(openAiKey) {
+    let apiKey = openAiKey;
+    let sqlitePath = 'omnikey-selfhosted.sqlite';
+    if (!apiKey) {
+        const answers = await inquirer_1.default.prompt([
+            {
+                type: 'input',
+                name: 'apiKey',
+                message: 'Enter your OPENAI_API_KEY:',
+                validate: (input) => input.trim() !== '' || 'API key cannot be empty',
+            },
+            {
+                type: 'input',
+                name: 'sqlitePath',
+                message: 'SQLite DB file path:',
+                default: 'omnikey-selfhosted.sqlite',
+            },
+        ]);
+        apiKey = answers.apiKey;
+        sqlitePath = answers.sqlitePath;
+    }
+    // Save all environment variables to ~/.omnikey/config.json
+    const configDir = path_1.default.join(process.env.HOME || process.env.USERPROFILE || '.', '.omnikey');
+    const configPath = path_1.default.join(configDir, 'config.json');
+    fs_1.default.mkdirSync(configDir, { recursive: true });
+    const configVars = {
+        OPENAI_API_KEY: apiKey,
+        IS_SELF_HOSTED: true,
+        SQLITE_PATH: sqlitePath,
+    };
+    fs_1.default.writeFileSync(configPath, JSON.stringify(configVars, null, 2));
+    console.log(`Environment variables saved to ${configPath}`);
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "omnikey-cli",
+  "version": "1.0.0",
+  "description": "CLI for onboarding users to Omnikey and configuring OPENAI_API_KEY. Use Yarn for install/build.",
+  "engines": {
+    "node": ">=14.0.0",
+    "yarn": ">=1.22.0"
+  },
+  "bin": {
+    "omnikey": "dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "copy-backend": "rm -rf backend-dist && mkdir -p backend-dist && cp -R ../dist/* backend-dist/"
+  },
+  "keywords": [
+    "cli",
+    "omnikey",
+    "onboarding",
+    "openai"
+  ],
+  "author": "Gurinder Rawala",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^11.0.0",
+    "inquirer": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/inquirer": "^9.0.9",
+    "typescript": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GurinderRawala/OmniKey-AI"
+  }
+}

package/src/daemon.ts

@@ -0,0 +1,43 @@
+import { spawn } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+
+/**
+ * Start the Omnikey API backend as a daemon on the specified port.
+ * @param port The port to run the backend on
+ */
+export function startDaemon(port: number = 7071) {
+  // Only use ~/.omnikey/config.json for environment variables
+
+  // Path to the backend entry point (now from backend-dist)
+  const backendPath = path.resolve(__dirname, '../backend-dist/index.js');
+
+  // Read and update environment variables from ~/.omnikey/config.json
+  const configDir = path.join(process.env.HOME || process.env.USERPROFILE || '.', '.omnikey');
+  const configPath = path.join(configDir, 'config.json');
+  let configVars: Record<string, any> = {};
+  if (fs.existsSync(configPath)) {
+    try {
+      configVars = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+    } catch (e) {
+      console.error('Failed to parse config.json:', e);
+    }
+  }
+  // Ensure both OMNIKEY_PORT and PORT are set for compatibility
+  configVars.OMNIKEY_PORT = port;
+  // Write the updated configVars back to config.json
+  try {
+    fs.mkdirSync(configDir, { recursive: true });
+    fs.writeFileSync(configPath, JSON.stringify(configVars, null, 2), 'utf-8');
+  } catch (e) {
+    console.error('Failed to write updated config.json:', e);
+  }
+  // Spawn the backend as a detached child process with env vars from config
+  const child = spawn('node', [backendPath], {
+    env: { ...process.env, ...configVars, OMNIKEY_PORT: String(port) },
+    detached: true,
+    stdio: 'ignore',
+  });
+  child.unref();
+  console.log(`Omnikey API backend started as a daemon on port ${port}`);
+}

package/src/index.ts

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { onboard } from './onboard';
+
+import { startDaemon } from './daemon';
+import { killDaemon } from './killDaemon';
+
+const program = new Command();
+
+program
+  .name('omnikey')
+  .description('Omnikey CLI for onboarding and configuration')
+  .version('1.0.0');
+
+program
+  .command('onboard')
+  .description('Onboard and configure your OPENAI_API_KEY')
+  .option('--open-ai-key <key>', 'Your OpenAI API Key')
+  .action(async (options) => {
+    await onboard(options.openAiKey || options.openAiKey || options['open-ai-key']);
+  });
+
+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')
+  .action((options) => {
+    const port = Number(options.port) || 7071;
+    startDaemon(port);
+  });
+
+program
+  .command('kill-daemon')
+  .description('Kill the Omnikey API backend daemon running on a specified port')
+  .option('--port <port>', 'Port to look for the daemon on', '7071')
+  .action((options) => {
+    const port = Number(options.port) || 7071;
+    killDaemon(port);
+  });
+
+program.parseAsync(process.argv);

package/src/killDaemon.ts

@@ -0,0 +1,28 @@
+import { execSync } from 'child_process';
+
+/**
+ * Kill the Omnikey API backend daemon running on a given port (default 7071).
+ * Looks for node processes running backend-dist/index.js on the specified port and kills them.
+ * @param port The port to look for (default 7071)
+ */
+export function killDaemon(port: number = 7071) {
+  try {
+    // Find the PID(s) of node processes running backend-dist/index.js on the given port
+    // macOS: lsof -i :PORT -t
+    const pids = execSync(`lsof -i :${port} -t`).toString().split('\n').filter(Boolean);
+    if (pids.length === 0) {
+      console.log(`No daemon found running on port ${port}.`);
+      return;
+    }
+    for (const pid of pids) {
+      try {
+        process.kill(Number(pid), 'SIGTERM');
+        console.log(`Killed daemon process with PID ${pid} on port ${port}.`);
+      } catch (e) {
+        console.error(`Failed to kill process ${pid}:`, e);
+      }
+    }
+  } catch (e) {
+    console.log(`No daemon found running on port ${port}.`);
+  }
+}

package/src/onboard.ts

@@ -0,0 +1,43 @@
+import inquirer from 'inquirer';
+import fs from 'fs';
+import path from 'path';
+
+/**
+ * Onboard the user by configuring their OPENAI_API_KEY and generating a .env for self-hosted use.
+ * @param openAiKey Optional key provided via CLI
+ */
+export async function onboard(openAiKey?: string) {
+  let apiKey = openAiKey;
+  let sqlitePath = 'omnikey-selfhosted.sqlite';
+
+  if (!apiKey) {
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'apiKey',
+        message: 'Enter your OPENAI_API_KEY:',
+        validate: (input: string) => input.trim() !== '' || 'API key cannot be empty',
+      },
+      {
+        type: 'input',
+        name: 'sqlitePath',
+        message: 'SQLite DB file path:',
+        default: 'omnikey-selfhosted.sqlite',
+      },
+    ]);
+    apiKey = answers.apiKey;
+    sqlitePath = answers.sqlitePath;
+  }
+
+  // Save all environment variables to ~/.omnikey/config.json
+  const configDir = path.join(process.env.HOME || process.env.USERPROFILE || '.', '.omnikey');
+  const configPath = path.join(configDir, 'config.json');
+  fs.mkdirSync(configDir, { recursive: true });
+  const configVars = {
+    OPENAI_API_KEY: apiKey,
+    IS_SELF_HOSTED: true,
+    SQLITE_PATH: sqlitePath,
+  };
+  fs.writeFileSync(configPath, JSON.stringify(configVars, null, 2));
+  console.log(`Environment variables saved to ${configPath}`);
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"]
+}