# CLI

QuickPod now has a Go-based CLI that covers the current user-facing QuickPod platform surface.

Repository:

* <https://github.com/quickpod/quickpod-cli>

## What the current CLI covers

The current CLI supports workflows for:

* search
* pods
* templates
* clusters
* serverless endpoints
* storage volumes
* machines
* account and auth
* catalog data
* host stores
* security and 2FA

## Install

Latest installer:

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

## Build from source

```bash
git clone https://github.com/quickpod/quickpod-cli.git
cd quickpod-cli
go build -o quickpod
```

## Authentication

The CLI supports bearer-token and secure-API-key based use.

Examples:

```bash
quickpod auth login --email you@example.com
quickpod auth me
quickpod --api-key "$QUICKPOD_API_KEY" pods list --kind gpu
```

## Common commands

Search offers:

```bash
quickpod search gpu --type A100 --max-hourly 2.5
quickpod search cpu --max-hourly 0.25 --min-count 8
```

Work with pods:

```bash
quickpod pods list --kind gpu
quickpod pods get --kind gpu --pod POD_UUID
quickpod pods create --kind gpu --template TEMPLATE_UUID --offer OFFER_ID --disk 50 --name trainer
quickpod pods stop --kind gpu --pod POD_UUID
```

Work with templates:

```bash
quickpod templates list --scope public --kind gpu
quickpod templates list --scope community --kind cpu
```

Work with clusters and serverless:

```bash
quickpod clusters list
quickpod serverless list
```

## Related docs

* [API Documentation](/api-and-cli/api-documentation.md)
* [Serverless](/console/serverless.md)
* [Clusters](/console/clusters.md)


---

# Agent Instructions: 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:

```
GET https://docs.quickpod.io/api-and-cli/cli.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.