Get started
1
Install the CLI
- npm
- Homebrew (macOS / Linux)
- PowerShell (Windows)
- Manual download
2
Verify the install
3
Authenticate
Save and verify your API key in one step.
login stores the key and checks it
against the API:4
Run your first lookup
Commands
Every lookup is available as a subcommand. Pass an email address as the argument (or a repository URL for GitHub Leaks).Authentication
The CLI resolves your API key using this priority chain:If no key is found, protected commands return an API key error.
Configuration
Config commands
Configuration is saved to
~/.encrata/config.yaml, written with 0600
permissions since it stores your API key:
Global options
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:
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.