> ## 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>

## Можливості

* Спілкування з моделями з використанням потокового виводу або інтерактивного REPL
* Перегляд метаданих каталогу моделей, зокрема полів provider, modality, endpoint, capability, context і pricing
* Перегляд однієї моделі за допомогою `cometapi model info <id>`
* Надсилання одного запиту через формати Chat Completions, Responses, Anthropic Messages або Gemini Generate Content за допомогою `cometapi run`
* Перевірка балансу, профілю акаунта, статистики використання, API-ключів, логів та історії асинхронних завдань
* Виведення даних у форматах table, 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` без повідомлення, щоб почати 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 key                                      |
| `account`         | Показати профіль акаунта                                                 |
| `stats`           | Показати статистику використання                                         |
| `tokens`          | Перелічити та шукати API key                                             |
| `logs`            | Переглядати журнали використання та експортувати CSV                     |
| `tasks`           | Переглядати журнали асинхронних завдань                                  |
| `init`            | Запустити майстер налаштування                                           |
| `doctor`          | Запустити діагностику конфігурації                                       |
| `config`          | Керувати локальною конфігурацією                                         |
| `repl`            | Запустити інтерактивну командну оболонку                                 |

## Посилання

* [Пакет PyPI](https://pypi.org/project/cometapi-cli/)
* [Довідник команд](/uk/libraries/cli/commands)
* [Посібник із конфігурації](/uk/libraries/cli/configuration)