For AI agents: llms.txt.

CLI

@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

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

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.
jobs <create|list|get|events|cancel|result>
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.
address <address>
Build a property & place report for a street address. It never names residents.
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.
Skip to content