> ## 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 package page](https://pypi.org/project/cometapi-cli/) を利用してください。このドキュメントでは、プライベートなソースリポジトリにアクセスしなくても、同じコマンドについて詳しく説明しています。

<Note>
  CometAPI CLI はベータ版です。インターフェースが安定するまで、コマンド名やオプションは変更される場合があります。
</Note>

## Features

* ストリーミング出力または対話型 REPL を使ってモデルとチャットする
* provider、modality、endpoint、capability、context、pricing フィールドを含むモデルカタログメタデータを参照する
* `cometapi model info <id>` で 1 つのモデルを確認する
* `cometapi run` を使って Chat Completions、Responses、Anthropic Messages、または Gemini Generate Content 形式で 1 回のリクエストを送信する
* 残高、アカウントプロフィール、使用統計、API keys、ログ、非同期タスク履歴を確認する
* table、JSON、YAML、CSV、または Markdown 形式でデータを出力する
* `~/.config/cometapi/config.toml` にローカル設定を保存する

## Prerequisites

* Python 3.10 以降
* [CometAPI API key](https://www.cometapi.com/console/token)

## Install the 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
```

## Start using the CLI

<Steps>
  <Step title="Configure credentials">
    セットアップウィザードを実行します:

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

    API key は環境変数でも設定できます:

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

    オプションの `COMETAPI_ACCESS_TOKEN` 値は、account、stats、tokens、logs、tasks コマンドでのみ必要です。
  </Step>

  <Step title="Chat with a model">
    1 件のチャットメッセージを送信します:

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

    メッセージを付けずに `cometapi chat` を実行すると、チャット REPL が開始されます。
  </Step>

  <Step title="Browse models">
    公開モデルカタログを検索します:

    ```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="Inspect one model">
    1 つのモデルの詳細メタデータを表示します:

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

    生の詳細ペイロードを出力します:

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

  <Step title="Run a multi-protocol request">
    デフォルトの chat エンドポイント経由で単発リクエストを送信します:

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

    リクエスト本文が別の provider スキーマに従う場合は、別の 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>

## Get command help

インストールされているバージョンのオプションを確認するには、ルートコマンドまたは任意のサブコマンドで `-h` を使用します:

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

## 主なコマンド

| Command           | Description                                            |
| ----------------- | ------------------------------------------------------ |
| `chat [MESSAGE]`  | チャットメッセージを送信する、またはチャット REPL を開始する                      |
| `models`          | モデルカタログのメタデータを一覧表示および絞り込みする                            |
| `model info <id>` | 1 つのモデルの公開メタデータを確認する                                   |
| `run [MODEL]`     | chat、responses、anthropic、または gemini 形式で 1 件のリクエストを送信する |
| `balance`         | アカウントまたは API キーの残高を表示する                                |
| `account`         | アカウントプロフィールを表示する                                       |
| `stats`           | 使用統計を表示する                                              |
| `tokens`          | API キーを一覧表示して検索する                                      |
| `logs`            | 使用ログを参照し、CSV をエクスポートする                                 |
| `tasks`           | 非同期タスクログを参照する                                          |
| `init`            | セットアップウィザードを実行する                                       |
| `doctor`          | 設定診断を実行する                                              |
| `config`          | ローカル設定を管理する                                            |
| `repl`            | 対話型コマンドシェルを開始する                                        |

## リンク

* [PyPI package](https://pypi.org/project/cometapi-cli/)
* [コマンドリファレンス](/ja/libraries/cli/commands)
* [設定ガイド](/ja/libraries/cli/configuration)