CLI Setup

The Pipelime CLI provides terminal-based access to all platform features.

Installation

npm install -g @Pipelime/cli

Authentication

Authenticate with your API key:

Pipelime auth login --api-key ki_your_key_here

The CLI stores credentials in ~/.Pipelime/config.json.

Configuration

Config File

The CLI reads configuration from ~/.Pipelime/config.json:

{
  "apiKey": "ki_your_key_here",
  "baseUrl": "https://app.Pipelime.io",
  "defaultOrganization": "org_123",
  "outputFormat": "table"
}

Environment Variables

You can also configure via environment variables:

Variable	Description
`Pipelime_API_KEY`	API key for authentication
`Pipelime_BASE_URL`	API base URL (default: `https://app.Pipelime.io`)
`Pipelime_ORG_ID`	Default organization ID
`Pipelime_FORMAT`	Output format: `table`, `json`, `quiet`

Output Formats

The CLI supports three output formats:

# Table format (default, human-readable)
Pipelime campaign list --format table

# JSON format (machine-readable)
Pipelime campaign list --format json

# Quiet format (IDs only, for scripting)
Pipelime campaign list --format quiet

Verify Installation

Pipelime --version
Pipelime whoami

CLI Setup

On this page