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

# Get started with the Plane CLI

> Install the Plane CLI, sign in, and run your first commands with interactive or non-interactive authentication.

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:

```bash theme={null}
curl -sSL https://plane.terminalwire.sh | bash
```

<Note>
  This installer also installs Terminalwire if it is not already available on your workstation.
</Note>

Restart your terminal after installation so your shell picks up the CLI in `PATH`.

## Verify the installation

Run:

```bash theme={null}
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:

```bash theme={null}
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:

```bash theme={null}
plane whoami
```

To remove local CLI credentials:

```bash theme={null}
plane logout
```

## Sign in with an API key prompt

If you prefer entering an API key in the terminal:

```bash theme={null}
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:

```bash theme={null}
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`:

```bash theme={null}
plane workers list --json | jq
```

JSON mode returns deterministic payload envelopes and does not include interactive UI artifacts.

## Next steps

<CardGroup cols={2}>
  <Card title="Plane CLI commands" icon="terminal" href="/guides/plane-cli-commands">
    See examples for every currently supported command and option.
  </Card>

  <Card title="Plane CLI troubleshooting" icon="screwdriver-wrench" href="/guides/plane-cli-troubleshooting">
    Resolve common installation and authentication issues.
  </Card>
</CardGroup>