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

# CometAPI CLI

> Установите и используйте интерфейс командной строки CometAPI, чтобы общаться с моделями, просматривать метаданные моделей, выполнять запросы по нескольким протоколам, проверять баланс и анализировать использование из терминала.

[CometAPI CLI](https://pypi.org/project/cometapi-cli/) — это официальный инструмент командной строки для CometAPI. Он помогает общаться с моделями, изучать каталог моделей, отправлять разовые запросы, проверять баланс и просматривать использование аккаунта из терминала.

Используйте [страницу пакета на PyPI](https://pypi.org/project/cometapi-cli/) как публичную домашнюю страницу для установки и метаданных пакета. Эта документация подробнее описывает те же команды без необходимости доступа к приватному репозиторию исходного кода.

<Note>
  CometAPI CLI находится в бета-версии. Названия команд и параметры могут изменяться, пока интерфейс не стабилизируется.
</Note>

## Возможности

* Общение с моделями с использованием Streaming-вывода или интерактивного REPL
* Просмотр метаданных каталога моделей, включая поля provider, modality, endpoint, capability, context и pricing
* Просмотр одной модели с помощью `cometapi model info <id>`
* Отправка одного запроса в форматах Chat Completions, Responses, Anthropic Messages или Gemini Generate Content с помощью `cometapi run`
* Проверка баланса, профиля аккаунта, статистики использования, API-ключей, логов и истории асинхронных задач
* Вывод данных в формате таблицы, JSON, YAML, CSV или Markdown
* Хранение локальной конфигурации в `~/.config/cometapi/config.toml`

## Предварительные требования

* Python 3.10 или новее
* [API-ключ CometAPI](https://www.cometapi.com/console/token)

## Установка CLI

Установите пакет из PyPI:

<CodeGroup>
  ```bash pip theme={null}
  pip install cometapi-cli
  ```

  ```bash pipx theme={null}
  pipx install cometapi-cli
  ```

  ```bash uv theme={null}
  uv tool install cometapi-cli
  ```
</CodeGroup>

Проверьте установленную команду:

```bash theme={null}
cometapi --version
cometapi -h
```

## Начало работы с CLI

<Steps>
  <Step title="Настройка учетных данных">
    Запустите мастер настройки:

    ```bash theme={null}
    cometapi init
    ```

    Вы также можете настроить API-ключ через переменную окружения:

    ```bash theme={null}
    export COMETAPI_KEY="your-api-key"
    ```

    Необязательное значение `COMETAPI_ACCESS_TOKEN` требуется только для команд account, stats, tokens, logs и tasks.
  </Step>

  <Step title="Общение с моделью">
    Отправьте одно сообщение в чат:

    ```bash theme={null}
    cometapi chat "Explain CometAPI in one sentence."
    ```

    Запустите `cometapi chat` без сообщения, чтобы открыть chat REPL.
  </Step>

  <Step title="Просмотр моделей">
    Выполните поиск по публичному каталогу моделей:

    ```bash theme={null}
    cometapi models --search gpt --limit 10
    ```

    Фильтруйте по метаданным каталога:

    ```bash theme={null}
    cometapi models --provider openai --type chat --limit 10
    cometapi models --feature image --endpoint responses --json
    ```
  </Step>

  <Step title="Просмотр одной модели">
    Покажите подробные метаданные одной модели:

    ```bash theme={null}
    cometapi model info your-model-id
    ```

    Выведите необработанный payload с подробной информацией:

    ```bash theme={null}
    cometapi model info your-model-id --json
    ```
  </Step>

  <Step title="Выполнение запроса по нескольким протоколам">
    Отправьте разовый запрос через chat endpoint по умолчанию:

    ```bash theme={null}
    cometapi run your-model-id -p "Reply with OK only."
    ```

    Выберите другой формат endpoint, если тело запроса соответствует другой схеме провайдера:

    ```bash theme={null}
    cometapi run your-model-id --endpoint responses -p "Reply with OK only." --json
    cometapi run your-model-id --endpoint anthropic -p "Reply with OK only." -i max_tokens=32
    cometapi run your-model-id --endpoint gemini -p "Reply with OK only." -i generationConfig.maxOutputTokens=32
    ```
  </Step>
</Steps>

## Получение справки по командам

Используйте `-h` с корневой командой или любой подкомандой, чтобы посмотреть параметры для установленной версии:

```bash theme={null}
cometapi -h
cometapi models -h
cometapi model info -h
cometapi run -h
```

## Основные команды

| Команда           | Описание                                                                  |
| ----------------- | ------------------------------------------------------------------------- |
| `chat [MESSAGE]`  | Отправить сообщение в чат или запустить chat REPL                         |
| `models`          | Показать и отфильтровать метаданные каталога моделей                      |
| `model info <id>` | Просмотреть публичные метаданные одной модели                             |
| `run [MODEL]`     | Отправить один запрос через форматы chat, responses, anthropic или gemini |
| `balance`         | Показать баланс аккаунта или API-ключа                                    |
| `account`         | Показать профиль аккаунта                                                 |
| `stats`           | Показать статистику использования                                         |
| `tokens`          | Показать список API-ключей и выполнить поиск                              |
| `logs`            | Просматривать журналы использования и экспортировать CSV                  |
| `tasks`           | Просматривать журналы асинхронных задач                                   |
| `init`            | Запустить мастер настройки                                                |
| `doctor`          | Запустить диагностику конфигурации                                        |
| `config`          | Управлять локальной конфигурацией                                         |
| `repl`            | Запустить интерактивную командную оболочку                                |

## Ссылки

* [Пакет PyPI](https://pypi.org/project/cometapi-cli/)
* [Справочник команд](/ru/libraries/cli/commands)
* [Руководство по конфигурации](/ru/libraries/cli/configuration)