SDKs & resources

CLI

Run lookups and manage durable work from your terminal.

@reloadapp/deepsearch is a single self-contained CLI - no runtime dependencies - that shares the same scopes, wallet metering, and sandbox behavior as the REST API. Run it with npx or install it globally as deepsearch. Requires Node.js ≥ 20.9.

Install

1
2
3
4
5
6# Run without installing anything
npx @reloadapp/deepsearch search "Ada Lovelace" --sandbox

# Or install globally, then call `deepsearch`
npm install -g @reloadapp/deepsearch
deepsearch --help

Authentication

The CLI resolves your key in order: --api-key › DEEPSEARCH_API_KEY › ~/.deepsearch/config.json (written by deepsearch login, stored with 0600 permissions). Lookup commands support --json, --sandbox, and --stream. Use --base-url for a development deployment and--timeout to bound a request.

Common commands

1
2
3
4
5
6
7
8
9
10
11
12
13
14# Save a key once (written to ~/.deepsearch/config.json, 0600)
deepsearch login

# Name search, then a streaming dossier
deepsearch search "Ada Lovelace" --type name --sandbox
deepsearch dossier "Ada Lovelace" --stream --sandbox

# Ask a follow-up, or queue an async job with an inline payload
deepsearch chat "Ada Lovelace" "Summarize the public sources" --sandbox
deepsearch jobs create dossier --input '{"person":{"name":"Ada Lovelace"}}' --sandbox --idempotency-key demo-1

# Added in the 0.1.1 source candidate
deepsearch companies Northwind --sandbox
deepsearch vin 1HGCM82633A004352 --sandbox

Commands

Command

Use

search <query>

Find people by name, phone, email, or username.

dossier <name>

Build or replay a public-footprint dossier.

chat <name> <message…>

Ask a follow-up question about a person.

Queue any lookup, page through jobs, follow progress, cancel, and retrieve results.

companies <query>

Find companies by name.

company <name>

Build a company dossier.

reverse-image <url>

Find public image appearances.

vin <vin>

Look up a 17-character vehicle VIN.

batch --input <json>

Run up to ten operations with per-item results.

status

Show developer API availability (no key required).

login

Save an API key and base URL to the CLI config.

config <get|set|path>

Inspect or edit stored CLI config.

Add --sandbox while integrating: it uses the published sandbox credential and returns deterministic Ada Lovelace fixtures and never consumes usage.