CLI Quickstart
Install the aventure CLI to look up any company or person by name, website,
or description from your terminal, then read its funding, founders, investors,
and news. You need an
aVenture account; the free plan works. For
Claude, ChatGPT, or another AI app, use the MCP server.
Get Started in One Step
Paste this into Claude Code, Codex, ChatGPT, or any assistant that can run terminal commands:
Set Up by Hand
Install
The CLI requires Node.js 24.22.1 or later.
If a global install fails with EACCES, use a writable user prefix and add
its executable directory to your shell’s path:
Keep that PATH setting in your shell configuration if you want it in later
terminal sessions.
Sign In
The command opens your browser to sign in and waits while you approve. Over
SSH or in a container, use aventure auth login --no-browser. When the issuer
supports device authorization, it prints a sign-in URL and a one-time code
to approve on another device. If device authorization is unavailable, follow
the reported error and the API-key approval fallback.
For CI, set AUTH_TOKEN to an API key instead.
Find a Company
The answer is the company’s profile; core.id is the id the commands below take.
With --json, it is at data.response.core.id. Check truncated before using
embedded funding, people, or news lists as complete; use the paginated reads
below to recover the sections you need.
This works on every plan.
Find a Company
On the free plan, lookup allows 20 names a day and search has its own daily
allowance of plain-English company and people searches; link search and page
reads need a paid plan (AI Plus or AI Pro), while
research runs require an eligible paid subscription.
Past a daily allowance, use a website with aventure entities lookup-exact get --url https://stripe.com or a keyword with aventure entities search --text-search Stripe.
Find a Person
Identify a company or person explains each lookup answer.
Go Deeper on a Record
Filter the company list with flags such as --stage, --headquarters-city,
and --industry:
Run aventure entities --help or aventure people --help for every command.
Plans and Usage
Calls draw on your plan’s monthly allowances. When one runs out, the command stops with a message that names the limit and how to upgrade.
Plans and usage covers upgrading.
Output and Exit Codes
--textis the default in a terminal: a table for a list and labeled fields for one record.--dataprints the response as JSON. It is the default when output is piped.--jsonprints the full result envelope, capped at 50 KB.--data-fullprints uncapped JSON for bounded programs; never use it in an LLM agent.--all-fieldsadds the detail fields that--texthides.
Exit code 0 means the call succeeded and 1 means it failed, so a script can
branch on the exit code without parsing output. With --json, check ok before
reading data.response.
--data also has a 50 KB limit and can return a truncation envelope instead
of the plain body. For automated research, use --json to keep ok, warnings,
continuation tokens, and truncation metadata in a consistent shape. A
successful exit code proves the operation worked, not that every nested
section is complete. Follow result recovery.
Find the Right Command
aventure help accepts an API reference operationId or a
command path, and prints the flags the command needs. For a body-based universal
lookup, the generated command is aventure lookup-from-file; its flags build
the JSON body for POST /v1/lookup.
Check Your Setup
aventure auth doctorchecks the CLI version, API connection, and sign-in, and names the fix for each problem.aventure auth statusshows which credential is in use.aventure auth logoutsigns you out.
Next Steps
- Get AI Plus for $49/mo to run
aventure search naturalpast the free daily allowance, search by link, read pages, and request research. - Answer a real question chains these commands into one result.
- Use cases and examples has a command recipe for each common job.
- MCP quickstart puts the same data inside an AI client.
- The CLI is published as
@aventurevc/aventure-cli, with source on GitHub.