@outerview/cli
The Outerview command-line client. It streams Outerview,
a visual index of the physical world, and prints the API response as JSON for
scripts, data workflows, and quick investigation.
Install
Run it once with npx, or install it globally:
npx @outerview/cli stream --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"
Stream
outerview stream --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 stream --query "public benches" --limit 50 > benches.json
Interactive-only results
Pass --interactive to send interactive: true. The resulting response only
contains captures suitable for an immersive interactive experience.
outerview stream --query "waterfront paths" --interactive --limit 50
Scope a stream to one or more positions. Repeat --position; the CLI sends
these points in the extensible position.points object and the API converts
each point to an H3 resolution-5 cell:
outerview stream --query "potholes" \
--position 40.7128,-74.0060 \
--position 40.7306,-73.9866 \
--limit 25
Use a Pro or Scale key to retrieve video capture URLs, then embed them with
@outerview/sdk-360.
Options
--query <text> | Required visual-world stream description. |
--limit <number> | Number of results, capped by your plan. |
--interactive | Restricts results to interactive captures. |
--position <lat,lon> | Filters the global namespace to one H3 resolution-5 cell; repeat for multiple positions. |
--api-key <key> | Overrides OUTERVIEW_API_KEY. |
--base-url <url> | Uses a compatible development API endpoint. |
Plans
Free: 5 RPM and 5 results. Starter: 500 RPM and 50 results. Pro: 2,000 RPM,
50 results, and video access. Scale: 8,000 RPM, 200 results, and video access.
Manage billing and API keys in the Outerview developer console.