> For the complete documentation index, see [llms.txt](https://developer.paddle.com/llms.txt).

# Build and work with Paddle integrations from your terminal with the Paddle CLI

The Paddle CLI lets you build and work with your Paddle integration from your terminal, in scripts and CI/CD pipelines, or through your AI agents.

---

## What's new?

You work in the terminal, and now Paddle does too. We've released the [Paddle CLI](https://developer.paddle.com/sdks/cli.md), a command-line tool for the Paddle API.

Use it to work with Paddle from your terminal, like setting up products and prices, looking up customers or subscriptions while you debug, or [simulating webhooks](https://developer.paddle.com/webhooks/simulator/test-webhooks.md) in your CI/CD pipeline when you merge a PR.

Turn a task into a set of commands once, then hand them to an agent or a scheduled routine to rerun whenever you need to.

## How it works

Here's what's in the initial release of the Paddle CLI:

- **Commands for Paddle API resources**  
  Manage Paddle entities like products, prices, customers, and subscriptions, with commands that match the [Paddle API](https://developer.paddle.com/api-reference.md). For example, `paddle products create` sends the same request as [create a product](https://developer.paddle.com/api-reference/products/create-product.md).
- **Support for AI agents**  
  The CLI detects popular agents like Claude Code, Cursor, and Codex, and switches to JSON output automatically. Agents can only run delete and cancel commands when they confirm the entity's Paddle ID.
- **Sandbox and live accounts**  
  Switch between your accounts using `paddle sandbox` and `paddle production`. The CLI displays the account name in color in the terminal so you can see when you're working with live data.

Install the CLI with Homebrew on macOS, or download it from GitHub for macOS, Linux, or Windows:

```sh
brew install paddlehq/tap/paddle
```

For other ways to install the CLI, like the install script or building from source, see [Install the Paddle CLI](https://developer.paddle.com/sdks/cli.md#install).

Log in with an API key, then run commands. This example uses a sandbox API key:

```sh
paddle login --environment sandbox --api-key YOUR_API_KEY
paddle products list
```

[View the Paddle CLI on GitHub](https://github.com/PaddleHQ/paddle-cli)

## Next steps

The Paddle CLI is available now as version `0.1.0`.

We use [semantic versioning](https://semver.org/) for our CLI. Commands and flags may change before `1.0.0`.

If you're using the CLI as part of scripts, CI/CD pipelines, or agentic workflows, we recommend pinning a specific install version, then updating your commands when you upgrade.

To get started, follow the [Paddle CLI quickstart](https://developer.paddle.com/get-started/quickstart/cli.md). It takes about five minutes to install the CLI, log in, and run your first command. To learn more, see the [Paddle CLI](https://developer.paddle.com/sdks/cli.md) documentation.

It's a non-breaking change, meaning it doesn't impact existing integrations.