> For the complete documentation index, see [llms.txt](https://docs.clore.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clore.ai/clore.ai/clore.ai-ru/razrabotchikam/cli-guide.md).

# Справочник CLI

The `clore` CLI позволяет управлять торговой площадкой GPU Clore.ai прямо из терминала — искать GPU, развёртывать инстансы, подключаться по SSH и управлять заказами без написания кода.

***

## Установка

```bash
pip install clore-ai
```

Это устанавливает и Python SDK, и `clore` команду CLI.

**Требования:** Python 3.9+

***

## Настройка

### Установите API-ключ

Получите свой ключ в [панели управления Clore.ai](https://clore.ai) → **разделе API** , затем настройте:

```bash
clore config set api_key YOUR_API_KEY
```

Это сохраняет ключ в `~/.clore/config.json`.

### Или используйте переменную окружения

```bash
export CLORE_API_KEY=your_api_key_here
```

### Просмотреть текущую конфигурацию

```bash
# Показать всю конфигурацию
clore config show

# Получить конкретное значение
clore config get api_key
```

***

## Команды

| Команда                               | Описание                                   |
| ------------------------------------- | ------------------------------------------ |
| `clore search`                        | Поиск на торговой площадке GPU             |
| `clore deploy <server_id>`            | Создать новый заказ (арендовать сервер)    |
| `clore orders`                        | Показать список ваших заказов              |
| `clore cancel <order_id>`             | Отменить заказ                             |
| `clore ssh <order_id>`                | Подключиться по SSH к активному заказу     |
| `clore wallets`                       | Показать балансы кошельков                 |
| `clore servers`                       | Показать список ваших размещённых серверов |
| `clore server-config <name>`          | Получить конфигурацию сервера              |
| `clore spot <server_id>`              | Показать спотовый рынок для сервера        |
| `clore spot-price <order_id> <price>` | Установить спотовую цену                   |
| `clore config set <key> <value>`      | Установить значение конфигурации           |
| `clore config get <key>`              | Получить значение конфигурации             |
| `clore config show`                   | Показать всю конфигурацию                  |
| `clore --version`                     | Показать версию                            |

***

## Подробное использование

### `clore search`

Поиск на торговой площадке GPU с фильтрами и сортировкой.

```bash
# Показать все доступные серверы (отсортированы по цене, топ-20)
clore search

# Фильтр по модели GPU
clore search --gpu "RTX 4090"

# Фильтр по GPU и максимальной цене
clore search --gpu "RTX 4090" --max-price 5.0

# Многопроцессорные GPU-сборки
clore search --min-gpu 4

# Сортировать по количеству GPU, показать топ-10
clore search --sort gpu --limit 10

# Комбинировать фильтры
clore search --gpu "A100" --min-ram 128 --max-price 10.0 --sort price --limit 5
```

**Параметры:**

| Параметр      | Тип                      | Описание                                             |
| ------------- | ------------------------ | ---------------------------------------------------- |
| `--gpu`       | текст                    | Фильтр по модели GPU (например, `"RTX 4090"`)        |
| `--min-gpu`   | целое число              | Минимальное количество GPU                           |
| `--min-ram`   | число с плавающей точкой | Минимальный объём RAM в ГБ                           |
| `--max-price` | число с плавающей точкой | Максимальная цена в USD/час                          |
| `--sort`      | выбор                    | Сортировать по: `price` (по умолчанию), `gpu`, `ram` |
| `--limit`     | целое число              | Максимум результатов для показа (по умолчанию: 20)   |

**Пример вывода:**

```
🔍 Торговая площадка GPU
┏━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━┓
┃ ID  ┃ GPU                             ┃ Кол-во┃ RAM (GB) ┃ CPU                          ┃ Цена/ч (USD)  ┃ Локация  ┃
┡━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━┩
│ 123 │ 1x NVIDIA GeForce RTX 4090      │     1 │    64.0  │ AMD Ryzen 9 5900X            │       $0.3200 │ US       │
│ 456 │ 2x NVIDIA GeForce RTX 4090      │     2 │   128.0  │ Intel Core i9-13900K         │       $0.5800 │ DE       │
└─────┴─────────────────────────────────┴───────┴──────────┴──────────────────────────────┴───────────────┴──────────┘
Показано 2 сервера
```

***

### `clore deploy <server_id>`

Создайте новый заказ, чтобы арендовать GPU-сервер.

```bash
# Заказ по требованию с SSH
clore deploy 123 \
  --image cloreai/ubuntu22.04-cuda12 \
  --type on-demand \
  --currency bitcoin \
  --ssh-password MySecurePass123 \
  --port 22:tcp \
  --port 8888:http

# Спотовый заказ
clore deploy 123 \
  --image cloreai/pytorch \
  --type spot \
  --currency bitcoin \
  --spot-price 0.000005 \
  --port 22:tcp

# С переменными окружения
clore deploy 123 \
  --image cloreai/ubuntu22.04-cuda12 \
  --type on-demand \
  --currency bitcoin \
  --ssh-password MyPass123 \
  --port 22:tcp \
  --env WANDB_API_KEY=your_key \
  --env HF_TOKEN=your_token
```

**Аргументы:**

| Аргумент    | Описание                                                          |
| ----------- | ----------------------------------------------------------------- |
| `server_id` | ID сервера, который нужно арендовать (возьмите из `clore search`) |

**Параметры:**

| Параметр         | Тип                      | Обязательно | Описание                                                                                       |
| ---------------- | ------------------------ | ----------- | ---------------------------------------------------------------------------------------------- |
| `--image`        | текст                    | Да          | Docker-образ (например, `cloreai/ubuntu22.04-cuda12`)                                          |
| `--type`         | выбор                    | Да          | `on-demand` или `spot`                                                                         |
| `--currency`     | текст                    | Да          | Валюта оплаты (например, `bitcoin`)                                                            |
| `--ssh-password` | текст                    | Нет         | Пароль SSH (буквенно-цифровой, максимум 32 символа)                                            |
| `--ssh-key`      | текст                    | Нет         | Публичный SSH-ключ                                                                             |
| `--port`         | текст                    | Нет         | Сопоставление портов (можно повторять), формат: `PORT:PROTOCOL`                                |
| `--env`          | текст                    | Нет         | Переменная окружения (можно повторять), формат: `KEY=VALUE`                                    |
| `--spot-price`   | число с плавающей точкой | Нет         | Спотовая цена в день (обязательно для спотовых заказов)                                        |
| `--gpu-count`    | целое число              | Нет         | Арендовать только N GPU (частичная аренда, только on-demand)                                   |
| `--gpu-indices`  | текст                    | Нет         | Номера GPU, разделённые запятыми, из `partial_gpu_rental.free_indices` (требует `--gpu-count`) |

***

### `clore orders`

Показать ваши активные заказы.

```bash
# Активные заказы
clore orders

# Включить завершённые/истёкшие заказы
clore orders --completed
```

**Параметры:**

| Параметр      | Описание                             |
| ------------- | ------------------------------------ |
| `--completed` | Включить завершённые/истёкшие заказы |

**Пример вывода:**

```
📦 Мои заказы
┏━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ ID ┃ ID сервера┃ Тип       ┃ Статус ┃ Образ                             ┃ IP                      ┃
┡━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ 38 │ 6         │ on-demand │ Активен│ cloreai/ubuntu22.04-cuda12        │ n1.c1.clorecloud.net    │
└────┴───────────┴───────────┴────────┴───────────────────────────────────┴─────────────────────────┘
Всего: 1 заказ
```

***

### `clore cancel <order_id>`

Отменить активный заказ.

```bash
# Отменить заказ
clore cancel 38

# Отмена с сообщением о проблеме
clore cancel 38 --issue "GPU перегревался"
```

**Аргументы:**

| Аргумент   | Описание             |
| ---------- | -------------------- |
| `order_id` | ID заказа для отмены |

**Параметры:**

| Параметр  | Описание                              |
| --------- | ------------------------------------- |
| `--issue` | Причина отмены / сообщение о проблеме |

***

### `clore ssh <order_id>`

Автоподключение по SSH к работающему заказу. CLI определяет имя хоста и порт из данных вашего заказа.

```bash
# Подключиться как root (по умолчанию)
clore ssh 38

# Подключиться под другим пользователем
clore ssh 38 --user ubuntu
```

**Аргументы:**

| Аргумент   | Описание                                 |
| ---------- | ---------------------------------------- |
| `order_id` | ID заказа, к которому нужно подключиться |

**Параметры:**

| Параметр | По умолчанию | Описание             |
| -------- | ------------ | -------------------- |
| `--user` | `root`       | Имя пользователя SSH |

***

### `clore wallets`

Показать балансы ваших кошельков и адреса для пополнения.

```bash
clore wallets
```

**Пример вывода:**

```
💰 Балансы кошельков
┏━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Валюта           ┃ Баланс       ┃ Адрес для пополнения                     ┃
┡━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ bitcoin          │ 0.00153176   │ tb1q6erw7v02t7hakgmlcl4wfnlykzqj05alndruwr │
│ CLORE-Blockchain │ 150.00000000 │ cLr1q8x...                                │
└──────────────────┴──────────────┴───────────────────────────────────────────┘
```

***

### `clore servers`

Показать серверы, которые вы размещаете на маркетплейсе.

```bash
clore servers
```

***

### `clore server-config <name>`

Получить конфигурацию конкретного размещённого вами сервера.

```bash
clore server-config "MyGPU"
```

**Пример вывода:**

```
Сервер: MyGPU
ID: 42
Подключён: True
В сети: True
Видимость: public
Максимальная длительность аренды: 72
GPU: NVIDIA GeForce RTX 4090
Цена on-demand (USD): $0.35
Цена spot (USD): $0.18
CPU: AMD Ryzen 9 5900X 12-Core Processor
RAM: 64.0 GB
GPU: 1x NVIDIA GeForce RTX 4090
```

***

### `clore spot <server_id>`

Показать текущие предложения спотового рынка для сервера.

```bash
clore spot 6
```

**Пример вывода:**

```
📊 Спотовый рынок - Сервер 6
┏━━━━━━━━━━┳━━━━━━━━━━━┓
┃ ID заказа ┃ Цена      ┃
┡━━━━━━━━━━╇━━━━━━━━━━━┩
│ 39       │ 4.2e-06   │
└──────────┴───────────┘
```

***

### `clore spot-price <order_id> <price>`

Обновите цену в своём предложении на спотовом рынке.

```bash
clore spot-price 39 0.000003
```

> **Примечание:** Вы можете снижать спотовые цены только раз в 600 секунд и лишь на ограниченный шаг.

***

### `clore config`

Управление конфигурацией CLI.

```bash
# Установить API-ключ
clore config set api_key YOUR_API_KEY

# Получить значение
clore config get api_key

# Показать всю конфигурацию
clore config show
```

Конфигурация хранится в `~/.clore/config.json`.

***

## Сценарии

### Поиск → Аренда → SSH → Отмена

Типичный сквозной сценарий:

```bash
# 1. Найдите RTX 4090 дешевле $5/час
clore search --gpu "RTX 4090" --max-price 5.0 --sort price --limit 5

# 2. Разверните на самом дешёвом сервере (например, ID 123)
clore deploy 123 \
  --image cloreai/ubuntu22.04-cuda12 \
  --type on-demand \
  --currency bitcoin \
  --ssh-password MyPass123 \
  --port 22:tcp \
  --port 8888:http

# 3. Проверьте статус вашего заказа
clore orders

# 4. Подключитесь по SSH к инстансу (например, ID заказа 456)
clore ssh 456

# 5. Когда закончите, отмените заказ
clore cancel 456
```

### Следите за балансом перед арендой

```bash
# Проверьте, что у вас достаточно средств
clore wallets

# Найдите и арендуйте
clore search --gpu "A100" --sort price --limit 3
clore deploy 789 \
  --image cloreai/ubuntu22.04-cuda12 \
  --type on-demand \
  --currency bitcoin \
  --ssh-password SecurePass \
  --port 22:tcp
```

### Сценарий спотового рынка

```bash
# 1. Проверьте спотовые предложения для сервера
clore spot 6

# 2. Создайте спотовый заказ
clore deploy 6 \
  --image cloreai/pytorch \
  --type spot \
  --currency bitcoin \
  --spot-price 0.000005 \
  --ssh-password MyPass123 \
  --port 22:tcp

# 3. Отрегулируйте свою спотовую цену
clore spot-price 39 0.000003
```

### Управление размещением серверов

```bash
# Посмотреть ваши серверы
clore servers

# Проверить конфигурацию сервера
clore server-config "MyGPU"
```

***

## Дальше

* [**Python SDK**](/clore.ai/clore.ai-ru/razrabotchikam/python-sdk.md) — Автоматизируйте сценарии с помощью Python
* [**REST API**](/clore.ai/clore.ai-ru/dlya-khostov/api.md) — Документация по API в сыром виде
* [**On-Demand vs Spot**](/clore.ai/clore.ai-ru/dlya-arendatorov/on-demand-vs-spot.md) — Понять модели ценообразования


---

# 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.clore.ai/clore.ai/clore.ai-ru/razrabotchikam/cli-guide.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.