Install the Vainu CLI

macOS and Linux

curl -LsSf https://raw.githubusercontent.com/vainu-app/vainu-cli/main/scripts/install.sh | sh

Windows (PowerShell)

irm https://raw.githubusercontent.com/vainu-app/vainu-cli/main/scripts/install.ps1 | iex

Run Your First Query Using Vainu CLI

Open a terminal window. Use vainu login to authenticate in the platform and run your first query:

vainu login
vainu organizations --payload '{"query": {"?GTE": {"financial_data.revenue": 1000000}}, "fields": ["business_id", "name", "financial_data.revenue"], "database": "FI"}'

How to Use Your Vainu API Client ID and Secret

Alternativiely you can use your Client ID and Client Secret if you have created an OAuth 2.0 application in the Vainu Platform.

export VAINU_CLIENT_ID=your-client-id
export VAINU_CLIENT_SECRET=your-client-secret

vainu --auth-method oauth organizations --payload '{"query": {"?GTE": {"financial_data.revenue": 1000000}}, "fields": ["business_id", "name", "financial_data.revenue"], "database": "FI"}'

Verify your setup

Run vainu doctor. When the install and credentials are working, the output ends with All checks passed.

vainu doctor

Vainu CLI Commands

Organizations API (v3)

Command	Endpoint	Documentation	Recipes
`vainu organizations`	`POST /v3/organizations/`	Filtering Company Data, Data Reference, Response Formats, API reference	Simple Filtering, Filter Contacts, Technology Search, Geo Sphere, Track Modifications
`vainu organizations-async`	`POST /v3/organizations/async/`	Asynchronous Requests, API reference	Get All Companies in a Vainu List
`vainu organizations-count`	`POST /v3/organizations/count/`	Count Organizations API, API reference	Amount of Companies Matching the Query
`vainu organizations-search`	`POST /v3/organizations/search/`	Search Organizations API, API reference	Simple Fuzzy Search API
`vainu fields organizations`	`GET /v3/organizations_fields/`	Data Reference	—

Lists, signals, and agents

Command	Endpoint	Documentation	Recipes
`vainu lists`	`GET /v3/lists/organizations/`	List Management APIs, API reference	List Management Examples
`vainu lists static`	`/v3/lists/organizations/static/`	Create, Add, Remove	List Management Examples
`vainu lists dynamic`	`/v3/lists/organizations/dynamic/`	Create, Update	List Management Examples
`vainu signals-news`	`POST /v3/signals/news/`	Signals API (BETA)	—
`vainu signals-data-changes`	`POST /v3/signals/data-changes/`	Signals API (BETA)	—
`vainu enrichment-agent`	`POST /v3/enrichment_agent/`		Run Enrichment Agent for One Company

Prerequisites

Python 3.11 or later. The installer installs Python for you if it is missing.
A Vainu account with API access.
Credentials for the commands you plan to run. A static API key does not cover every command — see Authentication methods below.
Access to a terminal: Terminal on macOS, a shell on Linux, or PowerShell on Windows.