Skip to main content
This page documents the supported Plane CLI commands. The CLI supports authentication, read-only resource inspection, and the existing payment creation command.

​
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 and is the default.
  • --api-key prompts for API key entry in the terminal.
Do not pass --browser and --api-key together.

​
Read-Only Resource Commands

Most resource groups support list and get. List commands accept the shared pagination options documented below.
ResourceCommands
Benefit electionsplane benefit-elections list, plane benefit-elections get ID
Benefit enrollmentsplane benefit-enrollments list, plane benefit-enrollments get ID
Benefit eventsplane benefit-events list, plane benefit-events get ID
Benefit plansplane benefit-plans list, plane benefit-plans get ID
Benefit programsplane benefit-programs list, plane benefit-programs get ID
Chargesplane charges list, plane charges get ID [--expand FIELD]
Classificationsplane classifications list, plane classifications get ID
Compensationsplane compensations list, plane compensations get ID
Employmentsplane employments list, plane employments get ID
Eventsplane events list, plane events get ID
Labor taxesplane labor-taxes list, plane labor-taxes get ID
Leave balance transactionsplane leave-balance-transactions list --leave-balance-id ID, plane leave-balance-transactions get ID --leave-balance-id ID
Leave balancesplane leave-balances list, plane leave-balances get ID
Leave entitlementsplane leave-entitlements list, plane leave-entitlements get ID
Leave policiesplane leave-policies list, plane leave-policies get ID
Leave requestsplane leave-requests list, plane leave-requests get ID
Leavesplane leaves list, plane leaves get ID
Locationsplane locations list, plane locations get ID
Payment requestsplane payment-requests list, plane payment-requests get ID [--expand FIELD]
Paymentsplane payments list, plane payments get ID [--expand FIELD]
Payrollsplane payrolls list, plane payrolls get ID [--expand FIELD]
Positionsplane positions list, plane positions get ID
Refundsplane refunds list, plane refunds get ID
Reportingsplane reportings list, plane reportings get ID
Rolesplane roles list, plane roles get ID
Sandboxesplane sandboxes list, plane sandboxes get ID
Time entriesplane time-entries list, plane time-entries get ID
Worker addressesplane worker-addresses list, plane worker-addresses get ID
Worker beneficiariesplane worker-beneficiaries list, plane worker-beneficiaries get ID
Worker contactsplane worker-contacts list, plane worker-contacts get ID
Worker dependentsplane worker-dependents list, plane worker-dependents get ID
Workersplane workers list, plane workers get ID [--expand FIELD]
Workforce calculationsplane workforce-calculations get ID
Workforce plansplane workforce-plans list, plane workforce-plans get ID
Examples: 
plane workers list --limit 25
plane payment-requests get pr_abc123 --expand worker
plane benefit-plans list --json | jq

​
Payment Creation

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
Required options:
  • --worker
  • --amount
  • --currency
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.

​
Pagination Options

These options apply to list commands:
  • --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

​
Resource-Specific Filters

Some list commands support filters beyond pagination.
CommandFilters
plane benefit-elections list--worker, --plan, --enrollment, --status
plane benefit-enrollments list--worker, --event, --status
plane benefit-events list--program, --entity, --worker, --type
plane benefit-plans list--program, --provider, --type, --status
plane benefit-programs list--entity, --year, --status
plane charges list--updated-after
plane compensations list--worker, --status
plane labor-taxes list--country, --subdivision, --code, --category, --classification, --on
plane leave-balance-transactions list--leave-balance-id (required), --type, --status
plane leave-balances list--worker, --policy, --type
plane leave-entitlements list--worker, --policy, --type
plane leave-policies list--workspace, --type
plane leave-requests list--starts, --ends, --status, --worker, --leave
plane leaves list--starts, --ends, --worker, --status, --type
plane payment-requests list--status
plane payments list--updated-after
plane positions list--plan, --status
plane refunds list--status
plane worker-addresses list--worker, --purpose, --current
plane worker-beneficiaries list--worker, --type, --status
plane worker-contacts list--worker, --purpose, --status
plane worker-dependents list--worker, --relationship, --status
plane workers list--query, --email, --updated-after, --type, --country
plane workforce-plans list--status

​
Expandable Get Commands

Some get commands support --expand FIELD to include nested resources in the response. Pass multiple fields as separate values after --expand.
CommandOption
plane charges get ID--expand
plane payment-requests get ID--expand
plane payments get ID--expand
plane payrolls get ID--expand
plane workers get ID--expand
Example: 
plane payments get pt_abc123 --expand worker

​
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.