@outerview/cli

@outerview/cli

The Outerview command-line client. It searches Outerview, a visual index of the physical world, and prints the API response as JSON for scripts, data workflows, and quick investigation.

• Website: outerview.ai
• Documentation: outerview.ai/docs
• API limits and wallet billing: outerview.ai/docs/billing

Install

Run it once with npx, or install it globally:

npx @outerview/cli search --query "street trees in Toronto" --limit 50
npm install -g @outerview/cli

Set an API key before making requests:

export OUTERVIEW_API_KEY="ov_your_key"

On PowerShell:

$env:OUTERVIEW_API_KEY = "ov_your_key"

Search

outerview search --query "protected bike lanes in Montreal" --limit 50

The command writes the normal Outerview JSON response to stdout, so it works well with jq, files, or another process:

outerview search --query "public benches" --limit 50 > benches.json

360-only results

Pass --interactive to send interactive: true. The resulting response only contains captures suitable for an immersive 360 experience.

outerview search --query "waterfront paths" --interactive --limit 50

Use a Pro or Scale key to retrieve video capture URLs, then embed them with @outerview/sdk-360.

Options

Option	Description
--query <text>	Required visual-world search description.
--limit <number>	Number of results, capped by your plan.
--interactive	Restricts results to 360-capable captures.
--api-key <key>	Overrides OUTERVIEW_API_KEY.
--base-url <url>	Uses a compatible development API endpoint.

Plans

Free: 5 RPM and 5 results. Developer: 500 RPM and 50 results. Pro: 2,000 RPM, 50 results, and video access. Scale: 8,000 RPM, 200 results, and video access. Manage credits and API keys in the Outerview developer console.