ChirpieDocs
CLI

CLI Overview

Install and authenticate the Chirpie command-line interface.

The Chirpie CLI lets you post, manage accounts, and handle API keys from your terminal.

Installation

npm install -g chirpie
yarn global add chirpie
pnpm add -g chirpie

Or use directly with npx:

npx chirpie post "Hello from the CLI!"

Authentication

chirpie login

This opens your browser, signs you in, and saves an API key to ~/.chirpie/config.json automatically.

Manual Key

chirpie auth --key chirpie_sk_YOUR_KEY

Or set the environment variable:

export CHIRPIE_API_KEY=chirpie_sk_YOUR_KEY

The CHIRPIE_API_KEY environment variable takes precedence over the config file.

Check Status

chirpie whoami

Logout

chirpie logout

Removes the config file at ~/.chirpie/config.json.

Config File

The CLI stores its config at ~/.chirpie/config.json with 0600 permissions (readable only by your user):

{
  "api_key": "chirpie_sk_...",
  "base_url": "https://chirpie.ai"
}

Output Formats

All commands support --json for machine-readable output:

chirpie posts --json | jq '.[] | .id'

Without --json, output is formatted as human-readable tables and messages.

On this page