Veille

CLI

Install the Veille CLI SDK and make your first API call.

The official Veille command-line interface, with one command per endpoint.

Requirements

  • Node.js 20+

Install

npm install --global @veilleio/cli
veille --help
npx @veilleio/cli --help

Get your API key

Copy your API key from the Veille dashboard and set it in the VEILLE_API_KEY environment variable, which the SDK reads by default. Keep it out of source control.

export VEILLE_API_KEY="YOUR_API_KEY"
$env:VEILLE_API_KEY = "YOUR_API_KEY"

Usage

veille intelligence-email --query jane.doe@example.com
veille intelligence-email --help     # parameters of one command
veille endpoints                # every command and its HTTP path
veille endpoints search         # filter the list
echo '{"query": "jane.doe@example.com"}' | veille intelligence-email --params -
veille intelligence-email --params params.json --compact
veille request get /v1/usage
veille request post /v1/some/new/endpoint --params body.json
veille intelligence-email --query jane.doe@example.com | jq .

Exit codes

  • 0: success
  • 1: API or network failure
  • 2: invalid usage, such as an unknown command, a missing API key or a missing parameter

On this page