Skip to content

cli.md

Latest commit

 

History

History
206 lines (143 loc) · 7.52 KB

cli.md

File metadata and controls

206 lines (143 loc) · 7.52 KB
Raw

CLI reference

The wigolo binary is three things: an MCP server (the default, when run with no arguments), a set of management commands, and a one-shot runner for all ten tools.

wigolo                  Start MCP server on stdio (default)
wigolo <command>        Run a subcommand
wigolo <tool> <args>    Run a tool once (headless)

wigolo --help prints the full map; every subcommand and tool accepts --help.

The --json contract

Any command or tool run with --json emits exactly one machine-readable JSON document on stdout. All logs go to stderr, always. This means you can pipe wigolo into jq or another process without filtering:

wigolo search "zig comptime" --json 2>/dev/null | jq '.results[].url'

Management commands

init

wigolo init [--agents=<csv>] [--no-warmup] [--interactive] [--wizard]
            [--json] [--skip-verify] [--plain]
            [--provider=anthropic|openai|gemini|ollama] [--search=core|searxng|hybrid]

Unattended by default: wires the agents you name, persists settings, downloads the browser engine and on-device models, verifies them, and prints a per-component report. --no-warmup skips all downloads (lazy-load on first use). --interactive gives a plain-text prompt flow; --wizard the full TUI. An LLM key is only ever read from the WIGOLO_LLM_API_KEY env var, never from a flag. See getting started.

doctor

wigolo doctor [--fix] [--json]

Diagnoses the installation: data dir writability, browser engine, fetch tiers, on-device models, LLM provider status, search backend, per-engine health (with the exact env var that enables each keyed engine), cache stats, and telemetry state. --fix repairs known failures.

verify

wigolo verify [--plain] [--json]

End-to-end capability smoke check with real network calls. Exit 0 when all capabilities pass or skip; exit 1 when any fails.

status / health

wigolo status [--json]     # install state + connected agents
wigolo health [--json]     # probes the running daemon; exit code = status

config

wigolo config [--plain] [--json] [--set <key>=<value>] [--storage] [--cache-stats]
              [--export [path]] [--import <path>] [--cleanup <component>]
              [--force-wizard] [--uninstall --yes]

Interactive settings shell by default. --cleanup frees storage for cache|embeddings|models|browser|searxng. wigolo dashboard is an alias. See configuration.

setup

wigolo setup mcp [--agents=<csv>]

Wires wigolo into MCP clients (the same wiring init --agents does, standalone).

skills

wigolo skills <add|list|remove> [packs...] [--global] [--agent <id,...>] [--dry-run] [--json] [--force]

Installs skill packs for your coding agents. Full story in skills.

plugin

wigolo plugin add <git-url> [--yes]
wigolo plugin list [--json]
wigolo plugin validate [--json]
wigolo plugin remove <name>

See plugins.

tune

wigolo tune <list|show <domain>|reset <domain>|reset --all> [--json]

wigolo self-tunes per-domain fetch routing as it works: it promotes the TLS-impersonation tier where that's what succeeds, escalates to the browser engine when needed, reuses solved challenge clearances, and backs off politely after repeated blocks. tune list shows what it has learned per domain; tune reset clears it (useful when a site changes behavior).

auth

wigolo auth discover    # list attachable browser debug sessions
wigolo auth status      # current auth configuration

Pairs with the session env vars in configuration and use_auth: true on fetch/crawl.

backfill

wigolo backfill [--dry-run] [--limit N] [--batch-size N] [--json]

Computes embeddings for cached pages that don't have them yet (e.g. pages cached before the embedding index existed). Default batch size 32.

warmup

wigolo warmup [--all|--browser|--reranker|--embeddings]

Re-runs component downloads — for CI images or repairing a broken component. init already does this; you rarely need it directly.

serve

wigolo serve [--port N] [--host H] [--allow-unauthenticated]

Starts the HTTP daemon (REST + remote MCP). It streams protocol output, so there is no --json here. Full reference: REST API.

uninstall

wigolo uninstall [--yes] [--json]

Removes agent integrations (MCP config, instructions, skills, slash command). Keeps ~/.wigolo data; the command prints the full-cleanup path for your install method.

One-shot tools

All ten tools run headlessly. Tool parameters map 1:1 from the wire names to --kebab-case flags (see tools for semantics):

wigolo search <query>       [--max-results=N] [--category=...] [--include-domains=a,b]
                            [--time-range=...] [--exact-match] [--search-depth=...] ...
wigolo fetch <url>          [--render-js=auto|always|never] [--section=H] [--use-auth] ...
wigolo crawl <url>          [--strategy=bfs|dfs|sitemap|map] [--max-depth=N] [--max-pages=N] ...
wigolo extract <url>        [--mode=structured|schema|tables|metadata|selector|brand] ...
wigolo cache stats | cache search <query> | cache clear [--query=Q] [--url-pattern=P]
wigolo find-similar <url-or-concept>  [--max-results=N] [--mode=...] ...
wigolo research <question>  [--depth=quick|standard|comprehensive] [--max-sources=N] ...
wigolo agent <prompt>       [--urls=u1,u2] [--schema=JSON|@file] [--max-pages=N] ...
wigolo diff <url> | diff --old="text" --new="text"  [--output=...] [--granularity=...]
wigolo watch add <url> --interval=SECONDS | watch list | watch rm <id> | watch run <id>

JSON-valued flags (--schema, --headers, --actions, --agent-context) accept inline JSON or @file:

wigolo extract https://example.com/pricing --mode=schema --schema=@pricing-schema.json --json

Note on watch: a one-shot process can register and list jobs, but checks only run while a daemon (wigolo serve) or MCP session is alive.

Interactive shell

wigolo shell

A REPL over all ten tools with tab completion and persistent history (~/.wigolo/shell-history). One warm process means no per-command startup cost — much faster for exploratory sessions than repeated one-shots.

wigolo> help
  search <query> [--limit=N] [--domains=a,b] ...
  fetch <url> [--max-chars=N] [--section=HEADING]
  crawl <url> [--depth N] [--max-pages N] [--strategy=bfs|dfs|sitemap|map]
  cache search <query> | cache stats | cache clear [--query=Q]
  extract <url> [--mode=...] [--selector=CSS]
  find-similar <url-or-concept> [--limit=N]
  research <question> [--depth=...]
  agent <prompt> [--urls=u1,u2]
  diff <url> [--output=...] [--granularity=...]
  watch add <url> [--interval=SECONDS] | watch list | watch rm <id>

  help          Show this help
  exit          Exit the shell
  .history      Show command history
  .json on|off  Toggle newline-delimited JSON output for tool results

Scripting the shell

The shell reads stdin, so you can pipe a script of commands through one warm process. --json (or .json on) switches results to newline-delimited JSON — one line per command — and a piped session exits 1 if any command failed, 0 otherwise:

printf 'search "bun test runner"\nfetch https://bun.sh/docs/cli/test\n' \
  | wigolo shell --json 2>/dev/null \
  | jq -r '.results[]?.url // .url'
echo "exit: $?"

← Docs index · Next: REST API