Getting Started - Paradime

Installation

To install the Paradime CLI, use pip:

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.

Bearer-token authentication (account and workspace API keys) requires paradime-io version 5.13.0 or later.

Generate Api Keys Legacy

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.

Account API Key
Workspace API Key [legacy]

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.

export PARADIME_API_ENDPOINT="YOUR_API_ENDPOINT"
export PARADIME_API_SECRET="prdm_cmp_..."
export PARADIME_WORKSPACE_UID="YOUR_WORKSPACE_UID"

Set the API Key and API Secret pair:

export PARADIME_API_ENDPOINT="YOUR_API_ENDPOINT"
export PARADIME_API_KEY="YOUR_API_KEY"
export PARADIME_API_SECRET="YOUR_API_SECRET"

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.

paradime login

CLI Usage

For the full specification of the CLI, run:

paradime --help

​Installation

​Obtaining API Credentials

Generate Api Keys Legacy

​Set the environment variables to start using the CLI

​CLI Usage

Bolt Cli

Installation

Obtaining API Credentials

Set the environment variables to start using the CLI

CLI Usage