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

# Get started with Paddle in the CLI

Install the Paddle CLI, log in to Paddle, and run your first commands directly from your terminal.

---

{% version-badge sdk="paddle-cli" /%}

This quickstart walks through installing the Paddle CLI, logging in to your sandbox account, and running your first commands in the terminal.

## Before you begin

You'll need:

- A [Paddle sandbox account](https://developer.paddle.com/sdks/sandbox.md).
- A [sandbox API key](https://developer.paddle.com/api-reference/about/authentication.md#create-an-api-key) with permission to read and write products.
- [Homebrew](https://brew.sh) if you're installing on macOS.

## Install the CLI {% step=true %}

{% tabs sync="cli-install-os" %}
{% tab-item title="macOS" %}

Install `paddlehq/tap/paddle` with [Homebrew](https://brew.sh):

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

{% /tab-item %}
{% tab-item title="Linux" %}

Install the Paddle CLI with the install script:

```sh
curl -fsSL https://raw.githubusercontent.com/PaddleHQ/paddle-cli/main/install.sh | sh
```

You can also install with Homebrew. See [Install the Paddle CLI](https://developer.paddle.com/sdks/cli.md#homebrew-linux).

{% /tab-item %}
{% tab-item title="Windows" %}

1. Download the Windows `.zip` archive from the latest [GitHub release](https://github.com/PaddleHQ/paddle-cli/releases/latest).
2. Optionally, download the `checksums.txt` file from the same release and verify the archive.
3. Extract `paddle.exe` from the archive to a permanent folder.
4. Add the folder containing `paddle.exe` to your `PATH`.
5. Open a new terminal before running any `paddle` commands. Terminals that were already open won't find `paddle`.

{% callout type="info" %}
Don't double-click `paddle.exe`, because the window opens and closes right away. Run `paddle` commands from a terminal instead.
{% /callout %}

{% /tab-item %}
{% /tabs %}

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

Check that the CLI is installed:

```sh
paddle --version
```

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

## Log in to Paddle {% step=true %}

Log in to your sandbox account with an API key:

```sh
paddle login --environment sandbox --api-key SANDBOX_API_KEY
```

Replace `SANDBOX_API_KEY` with your Paddle sandbox API key before running the command. Sandbox API keys contain `_sdbx`.

The CLI uses your live account by default, so include `--environment sandbox`. Without it, the CLI checks your sandbox key against your live account, and login fails. After you log in, the CLI keeps using your sandbox account until you switch.

To log in to your live account instead, run:

```sh
paddle login --environment production --api-key LIVE_API_KEY
```

You can also log in to your live account with OAuth. The CLI opens Paddle in your browser, where you log in and approve access. To learn more, see [Log in with OAuth](https://developer.paddle.com/sdks/cli.md#log-in-with-oauth).

You can always check which account you're connected to:

```sh
paddle whoami
```

## Run your first command {% step=true %}

Start by listing the products that exist in your sandbox account:

```sh
paddle products list
```

The terminal displays the result in a table. If you don't have any products yet, the CLI shows `No results.` Create a product in the Paddle dashboard, or use the CLI, passing a request body as JSON:

```sh
paddle products create --json '{"name": "AeroEdit Student", "tax_category": "standard"}'
```

If successful, Paddle returns the details of the product, including its `id`. Use the ID to view the product:

```sh
paddle products get PRODUCT_ID
```

Replace `PRODUCT_ID` with the `id` you received from `paddle products create`. Product IDs start with `pro_`.

## Find more commands {% step=true %}

Use `--help` to see every command in the Paddle CLI:

```sh
paddle --help
```

To check commands for a specific resource, add `--help` after the resource name:

```sh
paddle products --help
```

You can also check all flags and request body fields for a resource command:

```sh
paddle products create --help
```

Commands for each resource match the [Paddle API](https://developer.paddle.com/api-reference.md). `paddle products create` sends the same request as [create a product](https://developer.paddle.com/api-reference/products/create-product.md), so you can use the API reference to see every field.

## Use with an AI agent {% step=true %}

AI coding agents like [Claude Code](https://developer.paddle.com/get-started/ai/claude-code.md), [Cursor](https://developer.paddle.com/get-started/ai/cursor.md), [Codex](https://developer.paddle.com/get-started/ai/codex.md), and [Gemini CLI](https://developer.paddle.com/get-started/ai/gemini-cli.md) can run the Paddle CLI for you using the account you're logged in to.

Ask your agent to use the Paddle CLI in your prompt, or add an instruction to your project's `CLAUDE.md` or `AGENTS.md` file so it uses the CLI every time.

Commands that delete or cancel a resource only run if the agent adds `--confirm` with the resource's Paddle ID to explicitly confirm the operation.

## Next steps

- See [Create products and prices](https://developer.paddle.com/build/products/create-products-prices.md) to add prices to your product.
- Browse the [API reference](https://developer.paddle.com/api-reference.md) to see every operation you can run with the CLI.
- Get more details on logging in, settings, and every CLI command and flag in the [Paddle CLI overview](https://developer.paddle.com/sdks/cli.md).