OmniScout Docs

Configuration

config.toml, environment variables, storage, and JSON output.

config.toml

Create config.toml in your platform's config directory:

PlatformPath
macOS~/Library/Application Support/omniscout/config.toml
Linux~/.config/omniscout/config.toml
search_limit = 10
research_results = 8
request_throttle_seconds = 1.0
browser = "chrome"                    # chrome | edge | brave | vivaldi | opera | arc | chromium | custom
# browser_executable = "/path/to/browser"  # only needed for 'custom'

Prefer the CLI over hand-editing — omniscout settings set writes the same file:

omniscout settings set browser brave
omniscout settings show

Check install state with omniscout install, omniscout settings browsers, and omniscout settings engines.

Environment variables

VariablePurpose
OMNISCOUT_JSON=1Force JSON output on every command
OMNISCOUT_DATA_DIROverride the data directory
OMNISCOUT_BROWSERBrowser id (overrides config)
TWOCAPTCHA_API_KEY / CAPTCHA_API_KEYCAPTCHA solver key
OMNISCOUT_API_KEYCloud API key (Cloud SDK/CLI use)
OMNISCOUT_BASE_URLCloud base URL (default production)

JSON output

Every command speaks JSON — the agent integration surface:

omniscout --json answer "What is local-first software?"
export OMNISCOUT_JSON=1   # same for all commands in this shell

With JSON on, stdout is a structured payload and logs go to stderr (add -v/--verbose for more). Pipe through jq:

omniscout search "topic" | jq '.hits[] | {title, url}'

See Using with AI agents for the full agent loop.

Storage

Saved logins, memory, saved pages, and logs all live in the data dir. Keep them outside version control.

On this page