Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

This page documents all currently supported Plane CLI commands in the MVP.

​
Authentication commands

Use the top-level auth commands to manage your Plane CLI session. 
plane login
plane whoami
plane logout

​
Login options

plane login --browser
plane login --api-key
  • --browser starts browser-based authentication (default)
  • --api-key prompts for API key entry in the terminal
Do not pass --browser and --api-key together.

​
Workers

List workers: 
plane workers list
List workers with filters: 
plane workers list \
  --updated-after "2026-04-01T00:00:00Z" \
  --type employee \
  --country US
Get one worker by ID: 
plane workers get wr_abc123
Workers list filters:
  • --updated-after ISO 8601 timestamp filter
  • --type one of employee, contractor, vendor
  • --country country code filter

​
Payments

Create a payment: 
plane payments create \
  --worker wr_abc123 \
  --amount 1000 \
  --currency usd
Create a payment with optional fields: 
plane payments create \
  --worker wr_abc123 \
  --amount 1500 \
  --currency usd \
  --account ba_abc123 \
  --date 2026-04-22 \
  --reference "APR-2026-BONUS" \
  --note "Project completion bonus" \
  --period-start 2026-04-01 \
  --period-end 2026-04-30
Get one payment by ID: 
plane payments get pt_abc123
Payments create required options:
  • --worker
  • --amount
  • --currency
Payments create optional options:
  • --account
  • --date
  • --reference
  • --note
  • --period-start inclusive start date for an associated period (YYYY-MM-DD)
  • --period-end inclusive end date for an associated period (YYYY-MM-DD)
When you provide a period, pass both --period-start and --period-end together.

​
Compensations

List compensations: 
plane compensations list
Get one compensation by ID: 
plane compensations get cmp_abc123

​
Events

List events: 
plane events list
Get one event by ID: 
plane events get evt_abc123

​
Pagination options

These options apply to list commands (workers list, compensations list, and events list):
  • --limit maximum results (1-100)
  • --cursor pagination cursor
  • --starting-after return results after an ID
  • --ending-before return results before an ID
Example: 
plane workers list --limit 25 --starting-after wr_100

​
Output format

The CLI prints human-readable output by default. 
plane workers list
For machine-readable output, pass --json to functional commands: 
plane workers list --json | jq
JSON mode always returns a deterministic envelope (status with either data or error) and excludes CLI UI artifacts.