Getting Started

Install the Enrich Layer CLI, authenticate, and make your first API call in under 5 minutes.

Prerequisites

Node.js 20 or later
An Enrich Layer account (sign up)
Your API key (found in your dashboard)

Step 1: Install

npm install -g enrichlayer-cli

bash

Or with other package managers:

# Bun
bun install -g enrichlayer-cli

# Yarn
yarn global add enrichlayer-cli

bash

The package installs two binaries that point at the same script: el (short, default) and enrichlayer (full brand name). Use whichever you prefer; both accept identical arguments.

Verify:

el --version
# or, equivalent:
enrichlayer --version

bash

Step 2: Authenticate

The simplest way is browser-based login:

el login

bash

This opens your browser, authenticates your account, and stores the API key locally at ~/.config/enrichlayer/credentials.json.

For CI/CD or scripted use, set the environment variable instead:

export ENRICHLAYER_API_KEY=your_key_here

bash

For headless servers or SSH sessions, use the device code flow:

el login --device

bash

Step 3: Enrich a profile

el profile https://linkedin.com/in/satyanadella

bash

You'll see a formatted summary card. Add --full for the complete human-readable view or --json for raw data:

el profile https://linkedin.com/in/satyanadella --full
el profile https://linkedin.com/in/satyanadella --json

bash

Step 4: Try more commands

# Company enrichment
el company https://linkedin.com/company/microsoft

# Find a person by name and company
el profile lookup --name "Satya Nadella" --company microsoft.com

# Search for engineers at Google
el search person --company Google --title Engineer --limit 20

# Find a work email
el contact work-email https://linkedin.com/in/satyanadella

# Check your credit balance
el credits

bash

Step 5: Use it in scripts

The CLI is designed for both humans and automation. Pipe output to jq, save to files, or stream batch results as JSON Lines:

# Auto-JSON when piped
el profile https://linkedin.com/in/satyanadella | jq '.headline'

# Save raw JSON to a file
el profile https://linkedin.com/in/satyanadella --json -o profile.json

# Batch-enrich a file of LinkedIn URLs
el profile --file urls.txt --jsonl > profiles.jsonl

# Save credits by preferring cached data
el profile https://linkedin.com/in/satyanadella --use-cache if-present

bash

Step 6: Discover workflows

Run el how-to to explore recipe snippets for common use cases without leaving the terminal. AI agents can use --json to get a structured catalog:

el how-to --list              # List every recipe
el how-to lead-gen            # Show a specific recipe
el how-to --list --json       # Machine-readable catalog for agents

bash

Output formats

Every data command supports multiple output modes:

Flag	Output
(default, terminal)	Formatted summary card
(default, piped)	Full JSON
`--full`	Extended human-readable view with all fields
`--json`	Full JSON response
`--format csv`	CSV (spreadsheet import)
`--format yaml`	YAML
`--jsonl`	JSON Lines (one object per line, ideal for batch)
`--fields <list>`	Project specific fields (`full_name,headline,city`)
`--copy`	Copy the result to the clipboard
`-o, --output <file>`	Write the result to a file

Next steps

Commands — Full reference for every command and flag
Configuration — Shell completions, settings, and environment variables
API Reference — Detailed HTTP endpoint documentation

Getting Started

On this page