> For the complete documentation index, see [llms.txt](https://docs.paradime.io/app-help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.paradime.io/app-help/developers/paradime-cli/getting-started.md).

# Getting Started

## Installation

To install the Paradime CLI, use pip:

```bash
pip install paradime-io
```

## Obtaining API Credentials

Before you can use the Paradime SDK, you need to obtain the following API credentials for your workspace:

* `API Key`
* `API Secret`
* `API Endpoint`

{% content-ref url="/pages/ZsR10m0IstITtXbGOX9C" %}
[API Keys](/app-help/developers/generate-api-keys.md)
{% endcontent-ref %}

## Set the environment variables to start using the CLI

Finally use the API credentials you have generated to set these as environment variables in your system.

```bash
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 API credentials.

```bash
paradime login
```

## CLI Usage

{% content-ref url="/pages/HJZWwR3GOWaEvfY6u5tB" %}
[Bolt CLI](/app-help/developers/paradime-cli/bolt-cli.md)
{% endcontent-ref %}

For the full specification of the CLI, run:

```bash
paradime --help
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.paradime.io/app-help/developers/paradime-cli/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.