@aventurevc/aventure-cli 0.8.6 → 0.8.8

package/README.md

@@ -1,131 +1,113 @@
 # aVenture CLI
 
-Query aVenture's research data on companies, people, funding, and news from your
+Research private companies, founders, investors, funding rounds, and news from your
 terminal. The package installs one command, `aventure`.
 
-For a guided walkthrough, read the
-[aVenture CLI quickstart](https://docs.aventure.vc/cli).
+You need an aVenture account; free and paid plans both work.
+[Create an account](https://aventure.vc/sign-up).
 
-## Install
+## Get started in one step
 
-The CLI requires Node.js 24.18 or later in the 24.x series. Installation fails on
-any other major version.
+Paste this into Claude Code, Codex, ChatGPT, or any assistant that can run
+terminal commands:
 
-```sh
-npm install --global @aventurevc/aventure-cli --@aventurevc:registry=https://registry.npmjs.org/
-aventure --version
+```text
+Set up the aVenture CLI for me. Install it with
+`npm install --global @aventurevc/aventure-cli` (it needs Node.js 24.18.0 or
+later), then run `aventure auth login` so I can approve the sign-in in my browser (if no
+browser opens, show me the sign-in link and code it prints). When I'm signed in, run `aventure lookup Stripe` to confirm it
+works. Use `aventure --help` to find other commands.
+Docs: https://docs.aventure.vc/cli
 ```
 
-The `--@aventurevc:registry` flag makes npm install from the public npm registry
-even when your npm configuration maps the `@aventurevc` scope somewhere else.
+## CLI, MCP, or Researchly?
+
+| Where you work | Use |
+| --- | --- |
+| A terminal, shell scripts, or a coding agent with a shell | This CLI |
+| Claude, ChatGPT, or another desktop, web, or cloud AI app | The [aVenture MCP server](https://docs.aventure.vc/mcp) |
+| [Researchly](https://researchly.chat) | Nothing to install: open [Profile, then MCP servers](https://researchly.chat/profile/mcp-servers) and choose **Connect aVenture** |
 
-## Get a first result
+## Set up by hand
 
-Public reads need no account. This command finds a company by its website
-domain:
+Requires Node.js 24.18.0 or later.
 
 ```sh
-aventure entities lookup get --url-domain stripe.com
+npm install --global @aventurevc/aventure-cli
+aventure auth login
 ```
 
-## Sign in
+`aventure auth login` opens your browser to sign in and waits while you approve.
+Without a browser, such as over SSH or in a container, it prints a sign-in URL and
+a one-time code to approve on any device; `--no-browser` forces that mode.
 
-Name lookups and searches need a signed-in account. Choose one credential.
+For CI and other non-interactive environments, create a key in
+[API key settings](https://aventure.vc/settings/api-keys) and provide it in the
+`AUTH_TOKEN` environment variable from your secret manager.
 
-### Browser sign-in
+## Find a company
 
 ```sh
-aventure auth login
-aventure lookup Stripe
+aventure lookup Stripe                                   # by name
+aventure lookup --name Stripe --url https://stripe.com  # by website
+aventure search --query "payments infrastructure for online businesses"  # by description
 ```
 
-`aventure auth login` prints a one-time code and a sign-in URL, opens your browser
-when one is available, and waits until you approve. You can approve on any device,
-so the same command works on a laptop, over SSH, and in a container. Add
-`--no-browser` to print the URL without opening a browser. The approval page uses
-the aVenture account already signed in to that browser; to use another account,
-open the URL in a private window.
-
-The CLI saves the credential in your operating system's credential store. When no
-credential store is available, such as on a server without a desktop session, it
-saves the credential to `~/.config/aventure/credentials.json` with file mode
-`0600`. Expired access is renewed automatically.
+Add `--location` or `--context` to tell companies with the same name apart:
 
-Review or revoke CLI sign-ins in
-[aVenture developer access settings](https://aventure.vc/settings/developer).
+```sh
+aventure lookup Mercury --context "banking for startups" --location "San Francisco"
+```
 
-### Personal API key
+## Find a person
 
-Create a key in
-[aVenture API key settings](https://aventure.vc/settings/api-keys), then provide it
-in the `AUTH_TOKEN` environment variable from your shell or secret manager. Use
-this path for CI and other non-interactive environments.
+```sh
+aventure people lookup "Patrick Collison" --context "Stripe co-founder"
+aventure people lookup "Patrick Collison" --url https://www.linkedin.com/in/patrickcollison
+aventure search --query "fintech founders who previously worked at PayPal"
+```
 
-To create and save a key through browser approval instead, run
-`aventure auth login --key`.
+## Go deeper on a record
 
-### Check or remove a credential
+A lookup returns the record's `id`. Use it to read the full profile and what is
+attached to it:
 
-- `aventure auth status` shows which credential is in use and where it is stored,
-  without printing the secret.
-- `aventure auth doctor` checks the CLI version, API connection, credential, and
-  command catalog in one call, and names the command that fixes each failure.
-- `aventure auth logout` revokes the saved API key and removes the saved sign-in.
+```sh
+aventure entities get --entity-id <id>
+aventure entities fundraise-rounds list --entity-id <id>
+aventure people get --person-id <id>
+```
 
 ## Plans and usage
 
-Calls made with your credential count toward your aVenture plan's usage. Some
-operations, such as plain-English search, need a plan that includes them; without
-one, the API responds with status `402`.
-
-- Compare plans on the [aVenture pricing page](https://aventure.vc/pricing).
-- Check your plan and current usage in
-  [aVenture subscription settings](https://aventure.vc/settings/subscription).
-
-## Find commands
+Profile views, web searches, and research requests count toward your plan's monthly
+allowance. When one runs out, the command stops with a message that says which
+limit you reached and how to upgrade.
 
 ```sh
-aventure --help
-aventure entities --help
-aventure help entities lookup get
-aventure command-catalog search company lookup --format compact
+aventure billing subscription get                        # your plan and usage
+aventure billing plans list                              # monthly and annual prices
+aventure billing plan-changes create --plan <plan>       # upgrade a paid plan with the card on file
+aventure billing checkout-sessions create --plan <plan>  # subscribe from the free plan
 ```
 
-`aventure <command> --help` lists a command's options, and `aventure help <command>`
-prints its full documentation. `aventure command-catalog search` finds the command
-for a task without calling the API. Help and the catalog work without signing in.
-
-## Output and exit codes
-
-Every command accepts one output mode:
+You can also manage your plan in
+[subscription settings](https://aventure.vc/settings/subscription).
 
-- `--text` prints readable lines. It is the default in a terminal.
-- `--data` prints the response data as JSON. It is the default when output is
-  piped.
-- `--json` prints the full result envelope, capped at 50 KB.
-- `--data-full` prints uncapped JSON.
+## More
 
-The CLI exits with `0` when the call succeeded and `1` when it failed.
-
-## Shell completion and updates
-
-- `aventure completion zsh`, `aventure completion bash`, and
-  `aventure completion fish` print completion scripts, and
-  `aventure completion install` installs them.
-- `aventure update` checks for a newer release and installs it.
-
-## Diagnostics
-
-The CLI writes diagnostics to standard error and sends no telemetry.
+- `aventure --help` and `aventure <command> --help` list commands and options.
+- `aventure command-catalog search funding rounds --format compact` finds a command
+  for a task.
+- `--text` (terminal default), `--data` (JSON, default when piped), and `--json`
+  (full envelope) choose the output. Exit code `0` means success, `1` failure.
+- `aventure auth doctor` checks your setup and names the fix for each problem.
 
 ## Documentation
 
 - [CLI quickstart](https://docs.aventure.vc/cli)
-- [Authentication guide](https://docs.aventure.vc/authentication)
-- [Error reference](https://docs.aventure.vc/errors)
-- [API reference](https://docs.aventure.vc/api-reference)
-
-The command set is generated from the public aVenture OpenAPI specification.
+- [Authentication and plans](https://docs.aventure.vc/authentication)
+- [Errors](https://docs.aventure.vc/errors)
 
 ## License
 

package/dist/aventure-cli/command-catalog.compact.txt

@@ -32,7 +32,7 @@ aventure agents help answer · Deprecated: answer a natural-language platform he
 aventure agents instructions get · Deprecated: get one agent instruction document · --kind --name
 aventure auth api-key get · Get current API key · -
 aventure auth api-key revoke · Revoke current API key · -
-aventure auth providers get · Get the public authentication provider catalog · -
+aventure auth providers get · Get the sign-in options · -
 aventure billing ai-credits get · Read the current AI credit allowance · -
 aventure billing checkout-sessions create · Create or recover a hosted Checkout Session · --plan
 aventure billing plan-changes create · Change the subscription plan · --plan

package/dist/aventure-cli/index.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import{B as e,H as t,Rt as n}from"../chunks/auth-0-uOs6jd.js";import{t as r,v as i}from"../chunks/oauth-bearer-credential-CMTDaFL9.js";import{c as a,i as o,t as s}from"../chunks/openapi-commands-D7T7p2pw.js";import{r as c}from"../chunks/text-field-Cqpkg-8K.js";var l=process.argv.slice(2);o(l)&&t(!1),l.includes(`--all-fields`)&&c(!0);try{if(a(l,s)===`optional`)try{await r(),await i()}catch(t){e({component:`aventure-cli`,event:`optional_auth_materialization_failed`,message:`saved credential unavailable; continuing with credential-optional command`,error:t})}await import(`../chunks/aventure-cli-CKvL_6aV.js`)}catch(e){if(!(e instanceof n))throw e;process.stderr.write(`${e.message}\n`),process.exitCode=e.exitCode}export{};
+import{U as e,V as t,zt as n}from"../chunks/auth-SNOCQjGu.js";import{t as r,v as i}from"../chunks/oauth-bearer-credential-CMeOsJUQ.js";import{c as a,i as o,t as s}from"../chunks/openapi-commands-CHxJrl4n.js";import{r as c}from"../chunks/text-field-Boi8bbqF.js";var l=process.argv.slice(2);o(l)&&e(!1),l.includes(`--all-fields`)&&c(!0);try{if(a(l,s)===`optional`)try{await r(),await i()}catch(e){t({component:`aventure-cli`,event:`optional_auth_materialization_failed`,message:`saved credential unavailable; continuing with credential-optional command`,error:e})}await import(`../chunks/aventure-cli-tq4cxOnL.js`)}catch(e){if(!(e instanceof n))throw e;process.stderr.write(`${e.message}\n`),process.exitCode=e.exitCode}export{};

package/dist/aventure-cli/unified-operations.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": 1,
   "generatedFrom": "MCP_GENERATION_CONTRACT",
-  "generatedAt": "2026-09-26T12:02:50.142Z",
+  "generatedAt": "2026-09-27T10:00:08.601Z",
   "totalOperations": 134,
   "note": "Projection of MCP_GENERATION_CONTRACT - see mcp/scripts/build-unified-operations.ts header for SSOT rules.",
   "operations": [