CLI

The Encrata CLI runs every lookup from your terminal - no code required. Install it, save your API key once, and pipe results straight into your shell scripts.

Get started

Install the CLI

npm
Homebrew (macOS / Linux)
PowerShell (Windows)
Manual download

npm install -g encrata-cli

brew install Encratahq/tap/encrata

irm https://raw.githubusercontent.com/Encratahq/encrata-cli/main/install.ps1 | iex

Download a binary for your platform from GitHub Releases. Windows users can grab a windows_amd64.zip or windows_arm64.zip asset, extract it, and run encrata.exe.

Verify the install

encrata version

Authenticate

Save and verify your API key in one step. login stores the key and checks it against the API:

encrata login enc_xxxxxxxx   # or run `encrata login` to be prompted
encrata whoami               # confirm account, plan, credits, and workspace
encrata logout               # clear the saved key

Run your first lookup

encrata email satya@microsoft.com

Commands

Every lookup is available as a subcommand. Pass an email address as the argument (or a repository URL for GitHub Leaks).

Command	Lookup
`encrata email <address>`	Full email profile
`encrata email validity <address>`	Deliverability check
`encrata email identity <address>`	Person profile
`encrata email gender <address>`	Gender and country
`encrata email compliance <address>`	Cold-email jurisdiction
`encrata email breaches <address>`	Breach history
`encrata breaches github <repo-url>`	Scan a public repo for secrets

encrata email validity jane@acme.com
encrata email identity jane@acme.com --json

Add --json to any command to get raw JSON, ready to pipe into jq or a script.

Authentication

The CLI resolves your API key using this priority chain:

Priority	Source	How to set
1	`--api-key` flag	`encrata email validity jane@acme.com --api-key YOUR_API_KEY`
2	`ENCRATA_API_KEY` env var	`export ENCRATA_API_KEY=YOUR_API_KEY`
3	Config file	`encrata config set-key YOUR_API_KEY`

If no key is found, protected commands return an API key error.

Configuration

Config commands

Command	Description
`encrata config set-key YOUR_API_KEY`	Save your API key locally
`encrata config set-url http://localhost:8080`	Point the CLI at a custom API server
`encrata config show`	Show the current CLI configuration
`encrata config unset api-key`	Remove the saved key
`encrata config unset base-url`	Revert to the default API URL
`encrata config unset output`	Revert to table output

Configuration is saved to ~/.encrata/config.yaml, written with 0600 permissions since it stores your API key:

api_key: YOUR_API_KEY
base_url: https://developer.encrata.com
output: table

Global options

Flag	Description
`--json`	Print raw JSON output
`--api-key`	Override the saved API key
`--base-url`	Override the saved API base URL
`--quiet`	Suppress decorative output (headers, spinner); results still print
`--no-color`	Disable colored output (also honors the `NO_COLOR` env var)
`--timeout`	Per-request timeout in seconds (`0` = default 90s)

The ENCRATA_API_KEY, ENCRATA_BASE_URL, and NO_COLOR environment variables are all honored. The spinner auto-disables when output is not a terminal.

Output

Results display as a formatted table by default. Switch to raw JSON with --json:

encrata email satya@microsoft.com

encrata email satya@microsoft.com --json

Next steps

Lookups

See every lookup you can run and when to use each.

Quickstart

Prefer the API? Make your first lookup over HTTP.

All endpoints

Full request and response schemas for every lookup.

Source code

The CLI is open source on GitHub.

Overview

Configuration

Best practices

Get started

Commands

Authentication

Configuration

Config commands

Global options

Output

Next steps

Lookups

Quickstart

All endpoints

Source code

​Get started

​Commands

​Authentication

​Configuration

​Config commands

​Global options

​Output

​Next steps

Lookups

Quickstart

All endpoints

Source code

Get started

Commands

Authentication

Configuration

Config commands

Global options

Output

Next steps