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

# Overview

> Command line interface for managing Prime Intellect compute, RL environments and code sandboxes.

The Prime Intellect CLI provides a powerful command-line interface for managing all of our Prime Intellect offerings.
Including:

* Managing compute resources on our platform
* Creating, publishing and installing RL environments from our <Link href="https://app.primeintellect.ai/dashboard/environments" openInNewTab>environment hub</Link>
* Managing code sandboxes for secure code execution

<Note icon="github">
  Check out our [open source repository](https://github.com/PrimeIntellect-ai/prime-cli) on GitHub.
</Note>

## Quick Start

1. Install uv (if not already installed):

```bash theme={null}
curl -LsSf https://astral.sh/uv/install.sh | sh
```

2. Install the CLI with uv:

```bash theme={null}
uv tool install prime
```

3. Authenticate:

```bash theme={null}
prime login
```

Alternatively you can also manually set your <Link href="/api-reference/api-keys" openInNewTab>API key</Link> using `prime config set-api-key`

4. Configure SSH key for pod access:

```bash theme={null}
prime config set-ssh-key-path
```

<Tip>You can generate your ssh keys on <Link href="https://app.primeintellect.ai/dashboard/profile" openInNewTab>app.primeintellect.ai</Link> under the /dashboard/profile section. We recommend creating a dedicated directory for your Prime Intellect keys in your home directory, like `/Users/<username>/pi-keys`.</Tip>
5\. Verify your configuration:

```bash theme={null}
prime config view
```

<Frame>
  <img src="https://mintcdn.com/primeintellect/u4gd9w_CirhPniY2/images/cli/cli-config-view.png?fit=max&auto=format&n=u4gd9w_CirhPniY2&q=85&s=565c51879381e689fb53a1f2b807c6c4" alt="View CLI Configuration" width="1663" height="340" data-path="images/cli/cli-config-view.png" />
</Frame>

### Alternative Installation: Using pip

If you prefer not to use uv:

```bash theme={null}
pip install prime
```

## Key Features

* **GPU Resource Management**: Query and filter available GPU resources
* **Pod Management**: Create, monitor, and terminate compute pods
* **SSH Access**: Direct SSH access to running pods
* **Team Support**: Manage resources across team environments

## Basic Commands

```bash theme={null}
# List available GPUs
prime availability list

# Filter by GPU type
prime availability list --gpu-type H100_80GB

# Create a pod
prime pods create

# List your pods
prime pods list

# SSH into a pod
prime pods ssh <pod-id>
```

For detailed documentation on each command and feature, explore the sections above.

<CardGroup cols={2}>
  <Card title="Check GPU availability" icon="magnifying-glass" href="/cli-reference/check-gpu-availability">
    View and filter available GPU resources across providers using simple commands.
  </Card>

  <Card title="Provision Instances" icon="rocket" href="/cli-reference/provision-gpu">
    Create, monitor, and manage compute pods
    directly from your terminal.
  </Card>

  <Card title="Config Settings" icon="gear" href="/cli-reference/config-cli">
    Configure connection settings and team accounts.
  </Card>
</CardGroup>
