ValidKit CLI

Command-line interface for ValidKit email validation. Perfect for AI agents and automation.

Installation

npm install -g @validkit/cli

Or with yarn:

yarn global add @validkit/cli

Quick Start

1. Get your API key from https://validkit.com
2. Configure the CLI:

   validkit config --set-key YOUR_API_KEY

3. Verify an email:

   validkit verify [email protected]

Usage

Single Email Verification

# Basic verification
validkit verify [email protected]

# With debug information
validkit verify [email protected] --debug

# JSON output for scripts
validkit verify [email protected] --format json

# With trace ID for agent tracking
validkit verify [email protected] --trace-id "langchain-task-123"

Bulk Email Verification

# Verify emails from a file (one per line)
validkit bulk emails.txt

# Save results to file
validkit bulk emails.txt --output results.json

# Large batch with async processing
validkit bulk large-list.txt --async --webhook https://your-app.com/webhook

# Contribute to Agent Signal Pool
validkit bulk emails.txt --share-signals

Output Formats

• table (default) - Human-readable table format
• json - Full JSON response
• compact - Minimal output for scripts

Configuration

# Set API key
validkit config --set-key YOUR_API_KEY

# View current configuration
validkit config --get

# Reset configuration
validkit config --reset

Environment Variables

You can also set your API key via environment variable:

export VALIDKIT_API_KEY=your_api_key_here

Or in a .env file:

VALIDKIT_API_KEY=your_api_key_here

Examples

Shell Scripting

# Check if email is valid
if validkit verify [email protected] --quiet; then
  echo "Email is valid"
else
  echo "Email is invalid"
fi

# Process results with jq
validkit verify [email protected] --format json | jq '.valid'

Pipe Support

# Verify emails from another command
cat users.csv | cut -d',' -f3 > emails.txt
validkit bulk emails.txt

# One-liner for CSV processing
awk -F',' '{print $2}' contacts.csv | validkit bulk -

Agent Integration

# With trace ID for multi-agent systems
validkit bulk emails.txt \
  --trace-id "crewai-task-42" \
  --format json \
  --share-signals

Exit Codes

• 0 - Success (email is valid for single verification)
• 1 - Validation failed (email is invalid)
• 2 - Error (API error, network issue, etc.)

Features

• 🚀 Fast validation for single and bulk emails
• 🤖 Agent-friendly JSON output
• 📊 Progress indicators for bulk operations
• 🔄 Async processing for large batches
• 🔑 Secure API key storage
• 📝 Multiple output formats
• 🎯 Exit codes for scripting

Support

• Documentation: https://docs.validkit.com
• Issues: https://github.com/validkit/cli/issues
• Email: [email protected]

License

MIT