Command-line interface for Jiro. Serve, diagnose, search, and configure from the terminal.
The Jiro CLI is included with the Python package. Requires Python 3.10+.
Install globally with pip:
- pip install jirosearch
Verify the installation:
- jiro --version
The CLI provides commands for serving, searching, diagnosing, and configuring Jiro.
Complete list of all Jiro CLI commands:
| Name | Type | Description |
|---|---|---|
jiro serve | command | Start the Jiro API server. Accepts --host, --port, --workers, and --license-token flags. |
jiro search <query> | command | Search the web. Accepts --engine, --pages, --safe, and --base-url flags. |
jiro ai <query> | command | AI-powered search with multi-step reasoning. Accepts --model flag. |
jiro scrape <url> | command | Scrape and extract content from a URL. Accepts --format (markdown/text) flag. |
jiro doctor | command | Run built-in diagnostics. Checks Python, dependencies, Redis, config, and package integrity. |
jiro status | command | Show server status, version, credit balance, and enterprise license info. |
jiro mcp setup | command | Configure MCP for your AI coding client. Accepts --client flag. |
jiro mcp serve | command | Start the MCP server for stdio transport. Used by MCP clients. |
jiro bench | command | Run performance benchmarks. Accepts --iterations, --engine, and --concurrent flags. |
jiro --version | command | Show version information (e.g., `jiro v0.2.15`). |
jiro --help | command | Show help for all commands or a specific command. |
Start the Jiro API server. The server listens for incoming requests and proxies them to the configured search engines.
By default, the server starts on 0.0.0.0:8000. Use flags to customise the bind address, port, and worker count.
Search the web across 9 engines. Returns results in JSON format by default.
Accepts a query string and optional flags for engine selection, page count, and safe search filtering.
AI-powered search with multi-step reasoning. Runs multiple searches, analyses results, and synthesises a comprehensive answer.
Ideal for research questions, comparisons, and multi-faceted topics.
Run built-in diagnostics to check system health. Verifies Python version, dependencies, Redis connection, configuration validity, and package integrity.
Use this command when troubleshooting issues or after upgrading.
Show server status, version, credit balance, and enterprise license information.
Run performance benchmarks to measure throughput, latency, and engine response times.
Flags available on all commands:
| Name | Type | Description |
|---|---|---|
--base-url | string | Base URL of the Jiro server. Default: `http://localhost:8000`. Overrides JIRO_BASE_URL env var. |
--api-key | string | API key for authentication. Overrides JIRO_API_KEY env var. |
--format | string | Output format. Options: `json`, `text`, `table`. Default: `json`. |
--verbose | boolean | Enable verbose output. Shows request/response details. |
--no-color | boolean | Disable coloured output. |