Skip to content

CLI Reference

The CLI is lynox’s automation-oriented interface. All interactive features are in the Web UI.

Terminal window
npx @lynox-ai/core

Interactive Docker setup — creates docker-compose.yml, .env, SearXNG config, starts containers, and opens the browser.

Terminal window
npx @lynox-ai/core "Summarize the last 5 commits"

Runs a single task, streams the response to stdout, and exits. Great for scripting and CI.

Terminal window
cat report.csv | npx @lynox-ai/core "Analyze this data"

Combines piped input with a task prompt.

FlagDescription
--http-apiStart Engine HTTP API only (no Web UI)
--mcp-serverStart as MCP server (stdio)
--mcp-server --transport sseStart as MCP server (HTTP/SSE)
--manifest <file>Run a workflow manifest
--watch <glob> --on-change "<task>"Watch files and run task on change
--task "<title>"Create a background task and exit
--output <file>Save output to file
--project <dir>Set project directory
--data-dir <dir>Override data directory (default: ~/.lynox)
--initRe-run the Docker installer
--versionShow version (no API key required)
--helpShow help (no API key required)
NameModel
opusClaude Opus (most capable)
sonnetClaude Sonnet (balanced)
haikuClaude Haiku (fastest)
CodeMeaning
0Success
1Error (API failure, invalid config, etc.)