Pipedrive CLI

A fast, lightweight command-line interface for managing your Pipedrive CRM. Built with .NET 8 and Native AOT compilation for lightning-fast startup times (~13ms).

Features

⚡ Native AOT Compiled - 13ms cold start with 12MB binary size
🔐 Secure Configuration - Profile-based config stored at ~/.pipedrive/config.json
🌍 Environment Variables - Override config values via environment variables
🎨 Beautiful Console UI - Rich formatting with Spectre.Console
🔄 Multi-Profile Support - Manage multiple Pipedrive environments (dev, staging, prod)
📝 Full CRM Management - Complete CRUD operations for leads, deals, persons, organizations, activities, and notes
📧 Email History - View email conversations and threads for deals and contacts
🔀 Entity Merging - Merge duplicate persons, deals, and organizations with confirmation prompts
🏷️ Custom Fields - View custom fields with friendly names and update them via CLI
🔧 Pipeline Management - View pipelines and stages to understand your sales process
🤖 Scriptable - JSON output mode for automation and scripting
⬆️ Auto-Update - Background update checking with self-update capability

Getting Your Pipedrive Credentials

Before installing the CLI, you'll need two things from your Pipedrive account: a personal API token and your company domain.

Finding Your API Token

Log in to Pipedrive
Click Settings (gear icon, top-right)
Go to Personal preferences → API
Copy your personal API token

Security note: Your API token grants full access to your Pipedrive account. Never share it or commit it to source control.

Permission note: If you don't see the API tab, your account's permission set may not allow API access. Contact your Pipedrive administrator.

Finding Your Domain

Your domain is the subdomain visible in your browser's address bar when logged into Pipedrive:

https://acme.pipedrive.com/...
         ^^^^
         this is your domain

Use the full subdomain including .pipedrive.com — for example, acme.pipedrive.com.

Configuring the CLI (Recommended)

Use the CLI itself as your primary way to configure credentials — it stores them securely in ~/.pipedrive/config.json with restricted file permissions (600):

# Set your API key and domain
pipedrive config set --api-key YOUR_TOKEN --domain acme.pipedrive.com

# Verify the connection
pipedrive config test

# View your stored configuration (API key is masked)
pipedrive config get

For detailed configuration options including multiple profiles, see Configuration.

Installation

Quick Install (Recommended)

The easiest way to install Pipedrive CLI is using our installation scripts:

Linux & macOS

# Using curl
curl -sSL https://raw.githubusercontent.com/Aaronontheweb/pipedrive-cli/dev/install.sh | bash

# Or using wget
wget -qO- https://raw.githubusercontent.com/Aaronontheweb/pipedrive-cli/dev/install.sh | bash

Options:

# Download and run locally
curl -sSL https://raw.githubusercontent.com/Aaronontheweb/pipedrive-cli/dev/install.sh -o install.sh
chmod +x install.sh

# Dry run (download and verify without installing)
./install.sh --dry-run

# Install with beta/pre-release versions
./install.sh --beta

# Custom installation directory
INSTALL_DIR=/custom/path ./install.sh

# Uninstall
./install.sh --uninstall

The installer will:

Automatically detect your OS and architecture
Download the latest release from GitHub
Install to ~/.local/bin by default
Add the binary to your PATH if needed

Windows

# Using PowerShell (Run as Administrator recommended)
iwr -useb https://raw.githubusercontent.com/Aaronontheweb/pipedrive-cli/dev/install.ps1 | iex

Options:

# Download and run locally
Invoke-WebRequest -Uri https://raw.githubusercontent.com/Aaronontheweb/pipedrive-cli/dev/install.ps1 -OutFile install.ps1

# Dry run (download and verify without installing)
.\install.ps1 -DryRun

# Install with beta/pre-release versions
.\install.ps1 -Beta

# Custom installation directory
.\install.ps1 -InstallDir "C:\custom\path"

# Skip confirmation prompts
.\install.ps1 -Force

The installer will:

Automatically detect your system architecture
Download the latest release from GitHub
Install to %LOCALAPPDATA%\Programs\pipedrive by default
Add the binary to your PATH automatically

Manual Installation

If you prefer to build from source or need a development environment:

From Source

# Clone the repository
git clone https://github.com/Aaronontheweb/pipedrive-cli.git
cd pipedrive-cli

# Build and publish Native AOT binary
dotnet publish src/PipedriveCLI/PipedriveCLI.csproj -c Release -r linux-x64 --no-self-contained

# Copy binary to your PATH
sudo cp src/PipedriveCLI/bin/Release/net8.0/linux-x64/publish/pipedrive /usr/local/bin/

Using .NET Runtime (Development)

dotnet run --project src/PipedriveCLI/PipedriveCLI.csproj -- [command] [options]

Quick Start

Configure your Pipedrive credentials:

pipedrive config set --api-key YOUR_API_KEY --domain company.pipedrive.com

Test the connection:

pipedrive config test

View your configuration:

pipedrive config get

Configuration

Configuration File

The CLI stores configuration in ~/.pipedrive/config.json with secure file permissions (600 on Unix systems):

{
  "profiles": {
    "default": {
      "apiKey": "YOUR_API_KEY",
      "domain": "company.pipedrive.com"
    },
    "staging": {
      "apiKey": "STAGING_API_KEY",
      "domain": "staging.pipedrive.com"
    }
  },
  "activeProfile": "default"
}

Environment Variables

You can override configuration values using environment variables:

PIPEDRIVE_API_KEY - Override the API key
PIPEDRIVE_DOMAIN - Override the domain

Example:

export PIPEDRIVE_API_KEY="temporary-key"
pipedrive config get  # Will show the overridden value

Managing Profiles

Create a new profile with credentials:

# Create and configure a new profile without switching
pipedrive config set --profile staging --api-key STAGING_KEY --domain staging.pipedrive.com

List all profiles:

pipedrive config profile list

Switch to a different profile:

pipedrive config profile switch staging

Alternative: Set configuration for a specific profile after switching:

# First switch to the profile
pipedrive config profile switch staging

# Then configure it
pipedrive config set --api-key STAGING_KEY --domain staging.pipedrive.com

Commands

`config` - Configuration Management

Manage CLI configuration and profiles.

`config set` - Set Configuration Values

Set one or more configuration values for the active profile or a specific profile.

# Set API key and domain for the active profile
pipedrive config set --api-key YOUR_KEY --domain company.pipedrive.com

# Create and configure a new profile without switching to it
pipedrive config set --profile staging --api-key STAGING_KEY --domain staging.pipedrive.com

# Update a specific profile's API key
pipedrive config set --profile production --api-key PROD_KEY

# Options:
#   --api-key, -k     Pipedrive API key
#   --domain, -d      Pipedrive domain (e.g., company.pipedrive.com)
#   --profile, -p     Profile name to configure (creates if it doesn't exist)

`config get` - Display Current Configuration

View the current configuration with masked API keys.

pipedrive config get

Output:

╭─────────────┬───────────────────────────────────────╮
│ Setting     │ Value                                 │
├─────────────┼───────────────────────────────────────┤
│ Profile     │ default                               │
│ API Key     │ abc1****xyz9                          │
│ Domain      │ company.pipedrive.com                 │
│ Config File │ /home/user/.pipedrive/config.json     │
╰─────────────┴───────────────────────────────────────╯

`config test` - Test API Connection

Verify that your API credentials are valid by making a test request to Pipedrive.

pipedrive config test

`config profile list` - List All Profiles

Display all available configuration profiles.

pipedrive config profile list

Output:

╭───────────┬─────────────────────────┬─────────────╮
│ Profile   │ Domain                  │ Status      │
├───────────┼─────────────────────────┼─────────────┤
│ default   │ company.pipedrive.com   │ ✓ Active    │
│ staging   │ staging.pipedrive.com   │             │
│ prod      │ prod.pipedrive.com      │             │
╰───────────┴─────────────────────────┴─────────────╯

`config profile switch` - Switch Active Profile

Change which profile is currently active.

pipedrive config profile switch [profile-name]

# Example:
pipedrive config profile switch staging

`leads` - Leads Management

Manage Pipedrive leads with full CRUD operations and search capabilities.

# List all leads
pipedrive leads list [--limit 100] [--start 0]

# Get specific lead details
pipedrive leads get <id>

# Create a new lead
pipedrive leads create --title "Enterprise Deal" [--value 50000] [--expected-close-date "2025-12-31"]

# Update an existing lead
pipedrive leads update <id> --title "Updated Title" [--value 75000]

# Delete a lead
pipedrive leads delete <id> [--force]

# Search leads
pipedrive leads search "search term" [--limit 100]

`deals` - Deals Management

Manage deals with status filtering, custom field support, and merge capabilities.

# List all deals
pipedrive deals list [--status open|won|lost] [--limit 100] [--start 0]

# Get specific deal details (shows custom fields with friendly names)
pipedrive deals get <id>

# Get deal with raw custom field hash keys (for scripting)
pipedrive deals get <id> --raw-keys

# Get deal as JSON (for scripting/automation)
pipedrive deals get <id> --json

# Create a new deal
pipedrive deals create --title "Q4 License" --value 25000 [--currency USD] [--person-id 123] [--org-id 456]

# Update an existing deal
pipedrive deals update <id> --title "Updated Deal" [--value 30000] [--status won]

# Mark deal as lost with a reason
pipedrive deals update <id> --status lost --lost-reason "Customer chose competitor"

# Update deal with custom fields (use hash keys from --raw-keys)
pipedrive deals update <id> --custom-fields "hash1=value1,hash2=value2"

# Example: Update Phobos Expiration Date custom field
pipedrive deals update 1597 --custom-fields "6d3594d15856d7b77a2ab10a6c2c9603f90a5543=2026-05-11"

# Delete a deal
pipedrive deals delete <id> [--force]

# Merge duplicate deals
pipedrive deals merge <source-id> <target-id> [--force]
# Note: Source deal will be deleted, target deal takes priority in conflicts

`persons` - Persons (Contacts) Management

Manage contacts with email, phone, and organization associations.

# List all persons
pipedrive persons list [--limit 100] [--start 0]

# Get specific person details (includes custom fields)
pipedrive persons get <id>

# Create a new person
pipedrive persons create --name "John Doe" [--email john@example.com] [--phone "+1234567890"] [--org-id 123]

# Update an existing person
pipedrive persons update <id> --name "Jane Doe" [--email jane@example.com]

# Delete a person
pipedrive persons delete <id> [--force]

# Search persons
pipedrive persons search "search term" [--limit 100]

# Merge duplicate persons
pipedrive persons merge <source-id> <target-id> [--force]

`organizations` - Organizations Management

Manage companies and organizations with search and merge capabilities.

# List all organizations
pipedrive organizations list [--limit 100] [--start 0]

# Get specific organization details (includes custom fields)
pipedrive organizations get <id>

# Get organization as JSON (for scripting/automation)
pipedrive organizations get <id> --json

# Create a new organization
pipedrive organizations create --name "Acme Corp" [--address "123 Main St, City, State"]

# Update an existing organization
pipedrive organizations update <id> --name "Updated Corp" [--address "New Address"]

# Delete an organization
pipedrive organizations delete <id> [--force]

# Search organizations
pipedrive organizations search "search term" [--limit 100]

# Merge duplicate organizations
pipedrive organizations merge <source-id> <target-id> [--force]

`activities` - Activities Management

Manage tasks, calls, meetings, and other activities with due date tracking and user assignment.

# List all activities
pipedrive activities list [--done 0|1] [--limit 100] [--start 0]

# Get specific activity details
pipedrive activities get <id>

# Create a new activity
pipedrive activities create --subject "Follow-up call" --type call [--due-date "2025-12-31"]

# Create activity assigned to a specific user
pipedrive activities create --subject "Follow-up call" --type call --user-id 10204689

# Create activity for a deal or person
pipedrive activities create --subject "Demo" --type meeting --deal-id 123 [--person-id 456]

# Update an existing activity
pipedrive activities update <id> --subject "Updated subject" [--due-date "2026-01-15"]

# Delete an activity
pipedrive activities delete <id> [--force]

# Mark activity as done
pipedrive activities mark-done <id>

`notes` - Notes Management

Manage notes with HTML content support and entity associations.

# List all notes
pipedrive notes list [--limit 100] [--start 0]

# Get specific note details
pipedrive notes get <id>

# Create a new note
pipedrive notes create --content "Meeting notes here" [--deal-id 123] [--person-id 456] [--org-id 789]

# Update an existing note
pipedrive notes update <id> --content "Updated notes"

# Delete a note
pipedrive notes delete <id> [--force]

`pipelines` - Pipelines Management

View pipelines and their stages to understand your sales process structure.

# List all pipelines
pipedrive pipelines list

# Get specific pipeline details
pipedrive pipelines get <id>

# List all stages in a pipeline
pipedrive pipelines stages <id>

Example output for pipelines list:

╭──────┬─────────────────┬────────┬─────────╮
│ ID   │ Name            │ Active │ Deals   │
├──────┼─────────────────┼────────┼─────────┤
│ 1    │ Sales Pipeline  │ ✓      │ 45      │
│ 15   │ Phobos V2       │ ✓      │ 32      │
╰──────┴─────────────────┴────────┴─────────╯

Example output for pipelines stages 1:

╭──────┬──────────────────┬───────────┬──────────────╮
│ ID   │ Stage Name       │ Deals     │ Probability  │
├──────┼──────────────────┼───────────┼──────────────┤
│ 1    │ Lead In          │ 12        │ 10%          │
│ 2    │ Contact Made     │ 8         │ 20%          │
│ 3    │ Demo Scheduled   │ 15        │ 40%          │
│ 4    │ Proposal Made    │ 10        │ 80%          │
╰──────┴──────────────────┴───────────┴──────────────╯

`emails` - Email History

View email conversations and threads associated with deals and contacts. Essential for LLM agents and humans to understand prior context before reaching out.

# List emails for a deal
pipedrive emails list-for-deal <deal-id> [--limit 50] [--start 0]

# List emails for a person
pipedrive emails list-for-person <person-id> [--limit 50] [--start 0]

# Get a specific email message
pipedrive emails get <message-id>

# Get email with full body content
pipedrive emails get <message-id> --include-body

# List mail threads by folder
pipedrive emails threads [--folder inbox|sent|drafts|archive] [--limit 50] [--start 0]

# Get a specific mail thread
pipedrive emails thread <thread-id>

# Get all messages in a thread
pipedrive emails thread-messages <thread-id>

# Get all messages in a thread with full body content
pipedrive emails thread-messages <thread-id> --include-body

Example workflow for understanding deal history:

# 1. See that a deal has 9 emails
pipedrive deals get 835

# 2. List all emails for that deal
pipedrive emails list-for-deal 835

# 3. Read a specific email's full content
pipedrive emails get 12345 --include-body

`update` - Auto-Update

Check for and install CLI updates.

# Check for updates (stable releases only)
pipedrive update --check

# Install latest stable update
pipedrive update

# Check for updates including beta/pre-releases
pipedrive update --check --beta

# Install latest update (including betas) without confirmation
pipedrive update --beta --force

Getting Your API Key

See Getting Your Pipedrive Credentials near the top of this document.

Building from Source

Prerequisites

.NET 8 SDK or later
Linux, macOS, or Windows

Build Commands

# Standard build
dotnet build

# Run tests
dotnet test

# Publish Native AOT binary (Linux)
dotnet publish src/PipedriveCLI/PipedriveCLI.csproj -c Release -r linux-x64

# Publish Native AOT binary (macOS)
dotnet publish src/PipedriveCLI/PipedriveCLI.csproj -c Release -r osx-arm64  # M1/M2 Mac
dotnet publish src/PipedriveCLI/PipedriveCLI.csproj -c Release -r osx-x64    # Intel Mac

# Publish Native AOT binary (Windows)
dotnet publish src/PipedriveCLI/PipedriveCLI.csproj -c Release -r win-x64

Roadmap

The following features are planned for future releases:

Export & Analysis

Bulk Export - Export leads, deals, and contacts to CSV
AI-Powered Cleanup - Analyze and sanitize CRM data
Data Quality Reports - Identify incomplete or invalid data
Advanced Reporting - Generate custom reports and analytics

For the full list of planned features and to suggest new ones, visit the GitHub Issues page.

Architecture

Native AOT Compilation - Fast startup and small binary size
JSON Source Generators - AOT-compatible serialization
System.CommandLine - Modern CLI framework
Spectre.Console - Beautiful console UI
Multi-Profile Support - Manage multiple environments
Secure Storage - Config files protected with Unix file permissions

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

Support

For issues and questions:

Create an issue on GitHub
Check the Pipedrive API Documentation

Name		Name	Last commit message	Last commit date
Latest commit History 104 Commits
.azure		.azure
.config		.config
.github		.github
scripts		scripts
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
CLAUDE.md		CLAUDE.md
Directory.Build.props		Directory.Build.props
Directory.Packages.props		Directory.Packages.props
LICENSE		LICENSE
NuGet.Config		NuGet.Config
PipedriveCLI.slnx		PipedriveCLI.slnx
README.md		README.md
RELEASE_NOTES.md		RELEASE_NOTES.md
akkalogo.png		akkalogo.png
build.ps1		build.ps1
coverlet.runsettings		coverlet.runsettings
global.json		global.json
install.ps1		install.ps1
install.sh		install.sh

Folders and files

Latest commit

History

Repository files navigation

Pipedrive CLI

Table of Contents

Features

Getting Your Pipedrive Credentials

Finding Your API Token

Finding Your Domain

Configuring the CLI (Recommended)

Installation

Quick Install (Recommended)

Linux & macOS

Windows

Manual Installation

From Source

Using .NET Runtime (Development)

Quick Start

Configuration

Configuration File

Environment Variables

Managing Profiles

Commands

config - Configuration Management

config set - Set Configuration Values

config get - Display Current Configuration

config test - Test API Connection

config profile list - List All Profiles

config profile switch - Switch Active Profile

leads - Leads Management

deals - Deals Management

persons - Persons (Contacts) Management

organizations - Organizations Management

activities - Activities Management

notes - Notes Management

pipelines - Pipelines Management

emails - Email History

update - Auto-Update

Getting Your API Key

Building from Source

Prerequisites

Build Commands

Roadmap

Export & Analysis

Architecture

Contributing

License

Support

About

Resources

License

Code of conduct

Contributing

Uh oh!

Stars

Watchers

Forks

Releases 21

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

`config` - Configuration Management

`config set` - Set Configuration Values

`config get` - Display Current Configuration

`config test` - Test API Connection

`config profile list` - List All Profiles

`config profile switch` - Switch Active Profile

`leads` - Leads Management

`deals` - Deals Management

`persons` - Persons (Contacts) Management

`organizations` - Organizations Management

`activities` - Activities Management

`notes` - Notes Management

`pipelines` - Pipelines Management

`emails` - Email History

`update` - Auto-Update

Packages