@aventurevc/aventure-cli 0.7.329 → 0.8.0

package/README.md

@@ -1,60 +1,132 @@
-# aventure-cli
+# aVenture CLI
 
-The public aVenture CLI. Its public binary is `aventure`. Start with the
-[CLI quickstart](https://docs.aventure.vc/cli); every command and credential is
-documented at [docs.aventure.vc](https://docs.aventure.vc).
+Query aVenture's research data on companies, people, funding, and news from your
+terminal. The package installs one command, `aventure`.
 
-Requires Node.js 24.18 or later in the 24.x series.
+For a guided walkthrough, read the
+[aVenture CLI quickstart](https://docs.aventure.vc/cli).
 
-```bash
+## Install
+
+The CLI requires Node.js 24.18 or later in the 24.x series. Installation fails on
+any other major version.
+
+```sh
 npm install --global @aventurevc/aventure-cli --@aventurevc:registry=https://registry.npmjs.org/
-aventure status
-aventure help
+aventure --version
 ```
 
-## Authenticate
+The `--@aventurevc:registry` flag makes npm install from the public npm registry
+even when your npm configuration maps the `@aventurevc` scope somewhere else.
+
+## Get a first result
+
+Public reads need no account. This command finds a company by its website
+domain:
+
+```sh
+aventure entities lookup get --url-domain stripe.com
+```
 
-Choose one public user credential.
+## Sign in
 
-### Native OAuth
+Name lookups and searches need a signed-in account. Choose one credential.
 
-Run these commands in an interactive terminal:
+### Browser sign-in
 
 ```sh
 aventure auth login
-aventure entities list --entity-name Stripe
+aventure lookup Stripe
 ```
 
-Complete browser sign-in when prompted. The CLI stores the OAuth credential in
-the operating-system credential store, or in `~/.config/aventure/credentials.json`
-(mode `0600`) where the keyring cannot be used without a GUI session. An expired
-access token is renewed with its refresh token automatically. `aventure auth
-status` reports credential metadata, the store in use, and the sign-in providers
-without displaying any secret. `aventure auth logout` revokes the personal key,
-revokes the OAuth refresh token, and removes both local records.
+`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.
+
+Review or revoke CLI sign-ins in
+[aVenture developer access settings](https://aventure.vc/settings/developer).
 
 ### Personal API key
 
-Create a key at [aventure.vc/settings/api-keys](https://aventure.vc/settings/api-keys)
-with **Add new key**, then provide it through `AUTH_TOKEN` using your environment or
-secret manager. To create and store a personal key through browser approval, run
-`aventure auth login --key` in an interactive terminal. `aventure auth status`
-reports metadata without displaying the key. Help and the command catalog work
-without signing in.
+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.
+
+To create and save a key through browser approval instead, run
+`aventure auth login --key`.
+
+### Check or remove a credential
 
-## Headless authentication
+- `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.
 
-`aventure auth login` uses the OAuth device authorization grant: it prints a one-time
-code and a sign-in URL, opens the browser when one is available (`--no-browser` only
-skips that), you approve on any device, and the CLI polls until the sign-in completes.
-The same command works on a laptop, over SSH, and in a container. The verification
-page uses the account already signed in at `accounts.aventure.vc`; to choose another
-account, open the URL in a private window or sign out there first. `aventure auth
-login --key --no-browser` is the equivalent path for a personal API key, and an
-existing key can always be provided through `AUTH_TOKEN`.
+## Plans and usage
 
-The command catalog is generated from the public aVenture OpenAPI spec and must not be hand-edited.
+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
+
+```sh
+aventure --help
+aventure entities --help
+aventure help entities lookup get
+aventure command-catalog search company lookup --format compact
+```
+
+`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:
+
+- `--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.
+
+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 public package writes diagnostics to stderr and does not export telemetry.
+The CLI writes diagnostics to standard error and sends no telemetry.
+
+## 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.
+
+## License
+
+Apache License 2.0. See the [LICENSE file](LICENSE).

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

@@ -7,27 +7,26 @@ aventure content list · List content · -
 aventure content search · Search content · --query
 aventure entities get · Get one company, product, or service by id · --entity-id
 aventure entities lookup · Find which company a name refers to, or confirm it is new · --name
+aventure entities lookup-batch · Look up companies in bulk by id, slug, or URL · -
+aventure entities lookup-matches · Look up which company each identifier matches · -
 aventure entities natural-search · Deprecated: find companies in natural language · --query
 aventure entities search · Search companies, products, and services · -
 aventure help ask · Answer a natural-language platform help question · --question
-aventure lookup slug-redirects · Resolve slug redirect path · --path
-aventure lookup unique-ids · Look up an identifier owner · --id-type --identifier
 aventure news get · Get one news article · --news-id
 aventure news list · List news articles · -
 aventure news lookup · Look up one news article · -
 aventure people get · Get one person by id · --person-id
 aventure people lookup · Find which person a name refers to, or confirm they are new · --name
+aventure people lookup-batch · Look up people in bulk by id or slug · -
 aventure people natural-search · Deprecated: find people in natural language · --query
 aventure people search · Search people · -
-aventure provenance get · Get one recorded source for a field · --provenance-id
-aventure provenance list · List where a record's data came from · --table-name
 aventure resolve get · Deprecated: find the record behind an id, slug, or URL · --token
 aventure search all · Deprecated: search companies, people, and news together · --query
 aventure search link · Search from a page URL · --url
 aventure slug-redirects list · List a record's slug redirects · --resource-type --resource-id
-aventure slug-redirects lookup · Deprecated: resolve slug redirect path · --path
-aventure unique-ids lookup · Deprecated: look up an identifier owner · --id-type --identifier
-aventure url-types list · Deprecated: list the accepted values for --url-type · -
+aventure slug-redirects lookup · Resolve slug redirect path · --path
+aventure unique-ids lookup · Look up an identifier owner · --id-type --identifier
+aventure url-types list · List the accepted values for --url-type · -
 aventure web search · Search the live web · --search
 aventure agents help answer · Deprecated: answer a natural-language platform help question · --question
 aventure agents instructions get · Deprecated: get one agent instruction document · --kind --name
@@ -63,9 +62,7 @@ aventure entities fundraise-rounds list · List a company's funding rounds · --
 aventure entities investments list · List the investments a company made · --entity-id
 aventure entities investor-activity get · Get investor activity · --entity-id
 aventure entities investors list · List a company's investors · --entity-id
-aventure entities lookup batch · Look up companies in bulk by id, slug, or URL · -
-aventure entities lookup get · Read full entity detail by exact slug, URL, or domain · -
-aventure entities lookup matches · Look up which company each identifier matches · -
+aventure entities lookup-exact get · Read full entity detail by exact slug, URL, or domain · -
 aventure entities media get · Get a company media slot · --entity-id --media-type
 aventure entities people get · Get one person's role at a company · --entity-id --association-id
 aventure entities people list · List the people at a company · --entity-id
@@ -92,7 +89,6 @@ aventure entities urls get · Get one company URL · --entity-id --url-id
 aventure entities urls list · List a company's URLs · --entity-id
 aventure entities valuations list · List a company's valuation over time · --entity-id
 aventure help instructions get · Get one agent instruction document · --kind --name
-aventure lookup url-types list · List the accepted values for --url-type · -
 aventure news feedback create · Submit news feedback · -
 aventure news media get · Get news thumbnail · --news-id --media-type
 aventure news related-entities list · List the entities a news article is about · --news-id
@@ -110,8 +106,7 @@ aventure people filters search · Search people filter options · --filter-key -
 aventure people graph get · Get person graph · --person-id
 aventure people investments list · List a person's investments · --person-id
 aventure people investor-activity get · Get person investor activity · --person-id
-aventure people lookup batch · Look up people in bulk by id or slug · -
-aventure people lookup get · Read one person's full detail by exact slug or URL · -
+aventure people lookup-exact get · Read one person's full detail by exact slug or URL · -
 aventure people media get · Get person photo · --person-id --media-type
 aventure people repositories list · List a person's GitHub repositories · --person-id
 aventure people similar list · List people similar to one person · --person-id
@@ -121,14 +116,10 @@ aventure people unique-ids get · Get one person identifier · --person-id --uni
 aventure people unique-ids list · List a person's identifiers · --person-id
 aventure people urls get · Get one person URL · --person-id --url-id
 aventure people urls list · List person URLs · --person-id
-aventure provenance latest get · Get the newest source for a record · --table-name
 aventure search natural entities · Find companies, startups, and investors in natural language · --query
 aventure search natural people · Find people with natural language · --query
 aventure sec company lookup · Get SEC EDGAR facts for a public company · -
-aventure sitemap entities list · Paginated thin entity directory · -
-aventure sitemap index-manifest get · Sitemap index manifest · -
-aventure sitemap url-slots list · Paginated sitemap URL slots · --family
-aventure unique-ids types list · Deprecated: list the accepted unique identifier types · -
+aventure unique-ids types list · List the accepted unique identifier types · -
 aventure agents instructions manifest get · Deprecated: get the agent instruction manifest · -
 aventure agents instructions versions get · Deprecated: get one agent instruction document version · --kind --name --instruction-version
 aventure auth me permissions authorize · Authorize API operations · -
@@ -139,21 +130,10 @@ aventure entities filters counts list · List the company filter tag counts · -
 aventure entities products suggestions list · Suggest a company's products or services · --entity-id
 aventure entities relationships suggestions list · Suggest relationships for a company · --entity-id
 aventure entities relationships types list · List the accepted values for --type · -
+aventure entities research-details types list · List the accepted research detail types · -
+aventure entities research-snippets types list · List the accepted research snippet types · -
 aventure entities texts types list · List the accepted company text types · -
 aventure help instructions manifest get · Get the agent instruction manifest · -
 aventure help instructions versions get · Get one agent instruction document version · --kind --name --instruction-version
-aventure lookup unique-ids types list · List the accepted unique identifier types · -
 aventure people content facets list · Count a person's publications · --person-id
 aventure people texts types list · List the accepted person text types · -
-aventure sitemap entities boundaries get · Entity sitemap boundaries · --type-record
-aventure sitemap entities letter-counts get · Entity letter counts · -
-aventure sitemap entities routes list · Paginated sitemap-routes projection for an entity type · --type-record
-aventure sitemap entities urls list · Paginated sitemap URL slots for entity types · --type-record
-aventure sitemap news boundaries get · News sitemap boundaries · -
-aventure sitemap news letter-counts get · News author letter counts · -
-aventure sitemap people boundaries get · Person sitemap boundaries · -
-aventure sitemap people letter-counts get · People letter counts · -
-aventure sitemap url-slots boundaries get · Sitemap URL-slot boundaries · --family
-aventure entities research details types list · List the accepted research detail types · -
-aventure entities research snippets types list · List the accepted research snippet types · -
-aventure sitemap entities urls boundaries get · Entity sitemap URL boundaries · --type-record

package/dist/aventure-cli/index.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import{B as e,H as t,Lt as n}from"../chunks/auth-DD_CIwsI.js";import{t as r,v as i}from"../chunks/oauth-bearer-credential-BY_6si5M.js";import{c as a,i as o,t as s}from"../chunks/openapi-commands-DaOeLWGQ.js";import{r as c}from"../chunks/text-field-B07jcQqx.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-BBg4XH_i.js`)}catch(e){if(!(e instanceof n))throw e;process.stderr.write(`${e.message}\n`),process.exitCode=e.exitCode}export{};
+import{B as e,H as t,Lt as n}from"../chunks/auth-DTt1r8ab.js";import{t as r,v as i}from"../chunks/oauth-bearer-credential-DREFG9pZ.js";import{c as a,i as o,t as s}from"../chunks/openapi-commands-C9JKVw0Q.js";import{r as c}from"../chunks/text-field-jyeJ8k8G.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-ChRJCsYc.js`)}catch(e){if(!(e instanceof n))throw e;process.stderr.write(`${e.message}\n`),process.exitCode=e.exitCode}export{};