Skip to main content
The Polar CLI brings your Polar organization to your terminal. Use it to receive webhooks on your local machine while you build, send realistic sample events to your handler, and switch between your sandbox and production organizations.

Authentication

Sign in to sandbox and production, and choose the organization you work on.

Webhooks

Receive real webhooks locally and trigger sample events on demand.

Command reference

Every command, argument and flag.

​
Installation

The CLI ships as a single binary for macOS (Apple Silicon and Intel), Linux (x64) and Windows through WSL.
Terminal
Or with your package manager, on any platform. pnpm and bun block install scripts by default, and the flags below allow the one that unpacks the binary:
Terminal
Check that it works:
Terminal

​
Updating

The CLI checks for new releases in the background and tells you when one is available. Install it with:
Terminal

​
Shell completions

Print a completion script for your shell and add it to your profile:
Terminal
Bash, fish and sh are supported too. Run polar --help or add --help to any command for inline documentation.

​
Telemetry

The CLI sends one anonymous event per command to help us improve it: the command name, the names of the flags used (never their values), whether it succeeded, the duration, the CLI version, your operating system, and whether it ran in CI or from an AI coding agent. Events are keyed by a random install id. Access tokens, organization IDs, URLs and webhook payloads are never sent. To opt out, set either variable in your environment:
Terminal
The standard DO_NOT_TRACK=1 is honoured as well.