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.

Use the Plane CLI when you want to manage workers, payments, compensations, and events from your terminal.

​
Prerequisites

  • A Plane account
  • Access to your Plane workspace
  • macOS or Linux

​
Install the CLI

Run the Plane Terminalwire installer: 
curl -sSL https://plane.terminalwire.sh | bash
This installer also installs Terminalwire if it is not already available on your workstation.
Restart your terminal after installation so your shell picks up the CLI in PATH.

​
Verify the installation

Run: 
plane help
You should see command groups including workers, payments, compensations, and events.

​
Sign in interactively

By default, plane login starts browser-based sign-in: 
plane login
The CLI shows a verification code and URL, then prompts you to open your browser. After you complete sign-in, confirm your session: 
plane whoami
To remove local CLI credentials: 
plane logout

​
Sign in with an API key prompt

If you prefer entering an API key in the terminal: 
plane login --api-key
The key prompt is hidden input.

​
Use non-interactive authentication

For scripts, CI, and automation, set PLANE_API_KEY and run commands directly: 
PLANE_API_KEY=sk_live_... plane workers list
When PLANE_API_KEY is set, the CLI uses it for authentication instead of saved login state.

​
Use JSON output for automation

Functional commands print human-readable output by default. For machine-readable output, pass --json: 
plane workers list --json | jq
JSON mode returns deterministic payload envelopes and does not include interactive UI artifacts.

​
Next steps

Plane CLI commands

See examples for every currently supported command and option.

Plane CLI troubleshooting

Resolve common installation and authentication issues.