> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paradime.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

### Installation

To install the Paradime CLI, use pip:

```bash theme={"system"}
pip install paradime-io
```

### Obtaining API Credentials

Before you can use the Paradime CLI, you need to generate an API key and copy its **API Endpoint**. The CLI supports both key types — see API Keys to generate one.

<Info>
  Bearer-token authentication (account and workspace API keys) requires **`paradime-io` version 5.13.0 or later**.
</Info>

<Card title="Generate Api Keys Legacy" href="/developers/generate-api-keys-legacy" horizontal icon="arrow-right" />

### Set the environment variables to start using the CLI

Use the credentials you have generated to set these as environment variables in your system. Which variables you set depends on the type of API key you generated.

<Tabs>
  <Tab title="Account API Key">
    Set your account API key (starting with `prdm_cmp_`) as `PARADIME_API_SECRET`, and set `PARADIME_WORKSPACE_UID` to the workspace the CLI should run against (the `workspace_token` from Account Settings → Workspace). No `PARADIME_API_KEY` is needed.

    ```bash theme={"system"}
    export PARADIME_API_ENDPOINT="YOUR_API_ENDPOINT"
    export PARADIME_API_SECRET="prdm_cmp_..."
    export PARADIME_WORKSPACE_UID="YOUR_WORKSPACE_UID"
    ```
  </Tab>

  <Tab title="Workspace API Key [legacy]">
    Set the `API Key` and `API Secret` pair:

    ```bash theme={"system"}
    export PARADIME_API_ENDPOINT="YOUR_API_ENDPOINT"
    export PARADIME_API_KEY="YOUR_API_KEY"
    export PARADIME_API_SECRET="YOUR_API_SECRET"
    ```
  </Tab>
</Tabs>

Optionally, you can run the login CLI command to set the credentials interactively. It will prompt for the workspace UID automatically when you enter an account API key.

```bash theme={"system"}
paradime login
```

### CLI Usage

For the full specification of the CLI, run:

```bash theme={"system"}
paradime --help
```

<Card title="Bolt Cli" href="/developers/paradime-cli/bolt-cli" horizontal icon="arrow-right" />


## Related topics

- [Getting Started](/developers/webhooks/getting-started.md)
- [Paradime Setup and Configuration](/integrations/pre-commit/paradime-setup-and-configuration.md)
- [Copilot](/products/dino-ai/copilot/index.md)
- [Create Azure DevOps Items](/products/bolt/creating-schedules/templates/ticketing-templates/create-azure-devops-items.md)