Omnikey CLI

A command-line tool for onboarding users to the Omnikey open-source app, configuring your LLM provider (OpenAI, Anthropic, or Gemini), and setting up the web search tool.

About OmnikeyAI

OmnikeyAI is a productivity tool that helps you quickly rewrite selected text using your preferred LLM provider. The CLI allows you to configure and run the backend daemon on your local machine, manage your API keys, choose your LLM provider (OpenAI, Anthropic, or Gemini), and optionally configure the web search tool.

• Website: omnikeyai.ca
• For more details about the app and its features, see the main README.
• Download the latest macOS app here: Download OmniKeyAI for macOS
• Download the latest Windows app here: Download OmniKeyAI for Windows

Features

• omnikey onboard: Interactive onboarding to configure your LLM provider and API key.
• Supports OpenAI, Anthropic, and Google Gemini as LLM providers.
• Optional web search tool integration for enhanced responses.
• Accepts CLI flags for non-interactive setup.
• Configure and run the backend daemon — persisted across reboots on both macOS and Windows.

Usage

# Install CLI globally (from this directory)
npm install -g omnikey-cli

# Onboard interactively (will prompt for LLM key and web search tool)
omnikey onboard

# Start the daemon (auto-restarts on reboot)
omnikey daemon --port 7071

# Kill the daemon
omnikey kill-daemon

# Restart the daemon (kill + start in one step)
omnikey restart-daemon --port 7071

# Show current configuration (API keys are masked)
omnikey config

# Set a single configuration value
omnikey set OMNIKEY_PORT 8080

# Remove the config directory (keeps SQLite database)
omnikey remove-config

# Remove config and also the SQLite database
omnikey remove-config --db

# Check daemon status
omnikey status

# Check daemon logs
omnikey logs --lines 100

# Check daemon error logs only
omnikey logs --errors

Command reference

| Command | Description | |---|---| | omnikey onboard | Interactive setup for LLM provider and web search | | omnikey daemon [--port] | Start the backend daemon (default port: 7071) | | omnikey kill-daemon | Stop the running daemon | | omnikey restart-daemon [--port] | Kill and restart the daemon | | omnikey config | Display current config with masked API keys | | omnikey set <key> <value> | Update a single config value | | omnikey remove-config [--db] | Remove config files; add --db to also delete the database | | omnikey status | Show what process is using the daemon port | | omnikey logs [--lines N] [--errors] | Tail daemon logs |

Platform notes

macOS

The daemon is registered as a launchd agent (~/Library/LaunchAgents/com.omnikey.daemon.plist) so it auto-restarts after login and on crashes.

Windows

The daemon runs as a Windows Service managed by NSSM (Non-Sucking Service Manager). This gives it production-grade persistence:

| Behaviour | Detail | |---|---| | Starts on boot | Runs as SERVICE_AUTO_START — no login required | | Auto-restarts on crash | Restarts after a 3-second delay on any unexpected exit | | Runs in the background | No console window, no logged-in user needed | | Log rotation | stdout/stderr written to ~/.omnikey/daemon.log and daemon-error.log with rotation enabled |

Prerequisites

NSSM must be installed and the command must be run from an elevated (Administrator) terminal.

If NSSM is not found, omnikey daemon will prompt you:

? NSSM is required but not found. Install it now via winget? (Y/n)

Answering Y runs winget install nssm automatically and continues setup. Alternatively install it manually:

winget install nssm          # Windows Package Manager (built-in on Win 10/11)
scoop install nssm           # Scoop
choco install nssm           # Chocolatey

Service management

# View service status in Services console
services.msc

# Or via the command line
sc query OmnikeyDaemon

# Stop / start manually
nssm stop OmnikeyDaemon
nssm start OmnikeyDaemon

# Uninstall (also done automatically by omnikey kill-daemon / remove-config)
nssm remove OmnikeyDaemon confirm

Commands that query process state use netstat (instead of lsof) on Windows, and process termination uses taskkill (instead of SIGTERM).

Development

• Built with Node.js and TypeScript.
• Uses commander for CLI parsing and inquirer for prompts.
• Utilizes Yarn as the package manager.

License

MIT