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

# コマンドリファレンス

> chat、models、model info、run、balance、account、stats、tokens、logs、tasks、doctor、config、repl など、CometAPI CLI コマンドのリファレンス。

インストールされているバージョンの正確な引数とオプションを確認するには、`cometapi -h` または `cometapi <command> -h` を使用してください。

## コマンド概要

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

**Access token** と記載されたコマンドでは、`COMETAPI_ACCESS_TOKEN` 環境変数または `access_token` 設定キーが必要です。詳細は [設定ガイド](/ja/libraries/cli/configuration) を参照してください。

## Chat

単一のメッセージを送信するか、複数ターンのチャット REPL を開始します。

```bash theme={null}
cometapi chat "Explain CometAPI in one sentence."
cometapi chat "Summarize this" --model your-model-id --system "Be concise."
cometapi chat "Hello" --no-stream
cometapi chat "Hello" --json
cometapi chat
```

| Option                 | Short | Description        |
| ---------------------- | ----- | ------------------ |
| `--model`              | `-m`  | 使用するモデル            |
| `--system`             | `-s`  | システムプロンプト          |
| `--temperature`        | `-t`  | サンプリング温度           |
| `--max-tokens`         |       | 最大レスポンストークン数       |
| `--stream/--no-stream` |       | ストリーミングを有効または無効にする |
| `--format`             | `-f`  | 出力形式               |
| `--json`               |       | JSON として出力         |

## Models

デフォルトでは公開カタログからモデルを一覧表示します。カタログ出力には、model ID、provider、model type、features、endpoints、pricing、context length、maximum completion tokens が含まれます。

```bash theme={null}
cometapi models
cometapi models --search gpt --limit 10
cometapi models --provider openai --type chat --limit 10
cometapi models --feature image --endpoint responses --json
cometapi models --refresh
cometapi models --source openai --search gpt
```

| Option                      | Short | Description                                  |
| --------------------------- | ----- | -------------------------------------------- |
| `--search`                  | `-s`  | ID、code、name、description、または provider で絞り込み  |
| `--provider`                |       | provider 名または code で絞り込み                     |
| `--type`, `--modality`      |       | model type または modality で絞り込み                |
| `--feature`, `--capability` |       | feature または capability で絞り込み                 |
| `--endpoint`                |       | endpoint 名、method、または path で絞り込み             |
| `--limit`                   | `-l`  | 結果の最大件数                                      |
| `--source`                  |       | `catalog` メタデータまたは OpenAI 互換の `openai` 一覧を使用 |
| `--refresh`                 |       | 1 時間のカタログキャッシュを更新                            |
| `--no-cache`                |       | このコマンドではカタログキャッシュを使用しない                      |
| `--format`                  | `-f`  | 出力形式                                         |
| `--json`                    |       | JSON として出力                                   |

カタログキャッシュは `~/.cache/cometapi/models.json` に保存されます。

## モデル情報

1 つのモデルの公開メタデータを確認します。このコマンドは公開カタログを通じてモデルを解決し、その後カタログコードの詳細メタデータを読み込みます。

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

| Option       | Short | Description            |
| ------------ | ----- | ---------------------- |
| `--refresh`  |       | 検索前にカタログキャッシュを更新       |
| `--no-cache` |       | このコマンドではカタログキャッシュをバイパス |
| `--format`   | `-f`  | 出力形式                   |
| `--json`     |       | 生のモデル詳細 JSON を出力       |

テーブル出力には、provider、モデルタイプ、機能、エンドポイント、価格、コンテキスト長、最大 completion トークン数、ドキュメント URL、概要が含まれます。

## 実行

選択したエンドポイント形式で 1 件のリクエストを送信します。JSON ボディには `--input-file` を使用し、上書きには繰り返し指定する `-i key=value` を使用し、プロンプトのショートカットには `-p/--prompt` を使用します。

```bash theme={null}
cometapi run your-model-id -p "Write one sentence about CometAPI."
cometapi run your-model-id --endpoint responses -p "Reply with OK only." -i max_output_tokens=32 --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
cometapi run your-model-id --endpoint responses --input-file body.json -i temperature=0.2 --json
```

| Option         | Short | Description                                            |
| -------------- | ----- | ------------------------------------------------------ |
| `--endpoint`   | `-e`  | エンドポイント形式: `chat`、`responses`、`anthropic`、または `gemini` |
| `--input-file` |       | JSON オブジェクトのリクエストボディ                                   |
| `--input`      | `-i`  | `key=value` としてリクエスト入力を指定。複数の値を渡すには繰り返し使用              |
| `--prompt`     | `-p`  | プロンプトのショートカット                                          |
| `--json`       |       | 生の JSON レスポンスを出力                                       |

エンドポイントの対応関係:

| Endpoint    | Request path                       | Auth                                             |
| ----------- | ---------------------------------- | ------------------------------------------------ |
| `chat`      | `POST /v1/chat/completions`        | Bearer API key                                   |
| `responses` | `POST /v1/responses`               | Bearer API key                                   |
| `anthropic` | `POST /v1/messages`                | `x-api-key` API key and Anthropic version header |
| `gemini`    | Gemini Generate Content model path | `x-goog-api-key` API key                         |

ボディのマージ順は、`--input-file`、繰り返し指定する `-i key=value`、プロンプトのショートカット、最後に位置引数の `MODEL` です。インライン値は可能であれば JSON として解析されます。ドット区切りのキーはネストされたオブジェクトを作成します。

## 残高

CometAPI アカウント残高、または現在の API キーの請求ビューを表示します。

```bash theme={null}
cometapi balance
cometapi balance --source account
cometapi balance --source key
cometapi balance --json
```

| Option     | Short | Description                 |
| ---------- | ----- | --------------------------- |
| `--source` | `-s`  | データソース: `account` または `key` |
| `--format` | `-f`  | 出力形式                        |
| `--json`   |       | JSON として出力                  |

## アカウント

アカウントプロフィールを表示します。アクセストークンが必要です。

```bash theme={null}
cometapi account
cometapi account --json
```

## 統計

使用統計を表示します。アクセストークンが必要です。

```bash theme={null}
cometapi stats
cometapi stats --json
```

## トークン（Token）

API キーを一覧表示および検索します。アクセストークンが必要です。

```bash theme={null}
cometapi tokens
cometapi tokens --search project
cometapi tokens --json
```

| Option     | Short | Description  |
| ---------- | ----- | ------------ |
| `--search` | `-s`  | 検索キーワード      |
| `--page`   | `-p`  | ページ番号        |
| `--limit`  | `-l`  | 1 ページあたりの結果数 |
| `--format` | `-f`  | 出力形式         |
| `--json`   |       | JSON として出力   |

## ログ

フィルターを使って使用ログを閲覧します。アクセストークンが必要です。

```bash theme={null}
cometapi logs
cometapi logs --model your-model-id
cometapi logs --start 2026-04-01 --end 2026-04-14
cometapi logs --type consume
cometapi logs --export > usage.csv
cometapi logs --limit 50 --json
cometapi logs --request-id 20260617165550885561292gJBlzjtp
```

| Option         | Short | Description                            |
| -------------- | ----- | -------------------------------------- |
| `--model`      | `-m`  | model ID で絞り込み                         |
| `--token-name` | `-t`  | API キー名で絞り込み                           |
| `--type`       |       | ログの種類                                  |
| `--search`     | `-s`  | キーワード検索                                |
| `--start`      |       | 開始日                                    |
| `--end`        |       | 終了日                                    |
| `--group`      | `-g`  | API キーグループで絞り込み                        |
| `--request-id` |       | `X-Cometapi-Request-Id` で 1 件のリクエストを検索 |
| `--page`       | `-p`  | ページ番号                                  |
| `--limit`      | `-l`  | 1 ページあたりの結果数                           |
| `--export`     |       | サーバー側 CSV を stdout に出力                 |
| `--format`     | `-f`  | 出力形式                                   |
| `--json`       |       | JSON として出力                             |

`logs --request-id` は operator log endpoint に対して 1 回のインデックス検索を実行し、
完全一致の `request_id` のみを受け付けます。CLI はフォールバックのログページを走査しません。
これは self-log endpoint では `request_id` フィルタリングが適用されないためです。

## タスク

非同期タスクログを表示します。アクセストークンが必要です。

```bash theme={null}
cometapi tasks
cometapi tasks --platform kling
cometapi tasks --status SUCCESS
cometapi tasks --json
```

| Option       | Short | Description   |
| ------------ | ----- | ------------- |
| `--platform` | `-p`  | プラットフォームで絞り込み |
| `--task-id`  |       | タスク ID で絞り込み  |
| `--status`   | `-s`  | ステータスで絞り込み    |
| `--action`   | `-a`  | アクションタイプで絞り込み |
| `--start`    |       | 開始日           |
| `--end`      |       | 終了日           |
| `--page`     |       | ページ番号         |
| `--limit`    | `-l`  | 1 ページあたりの結果数  |
| `--format`   | `-f`  | 出力形式          |
| `--json`     |       | JSON として出力    |

## Doctor

設定と API 接続を検証するための診断を実行します。

```bash theme={null}
cometapi doctor
cometapi doctor --json
```

## Config

`~/.config/cometapi/config.toml` に保存されている CLI 設定を管理します。

```bash theme={null}
cometapi config show
cometapi config set api_key "$COMETAPI_KEY"
cometapi config set default_model your-model-id
cometapi config unset api_key
cometapi config path
```

利用可能なすべてのキーについては、[設定ガイド](/ja/libraries/cli/configuration)を参照してください。

## Init

対話型セットアップウィザードを実行します:

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

## Repl

完全な対話型コマンドシェルを開始します:

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

## 出力形式

ほとんどのデータコマンドは `--json` または `--format` をサポートしています:

```bash theme={null}
cometapi models --json
cometapi models --format yaml
cometapi stats --format csv
cometapi account --format markdown
```

| Format     | Description    |
| ---------- | -------------- |
| `table`    | ターミナルでのリッチテーブル |
| `json`     | JSON 出力        |
| `yaml`     | YAML 出力        |
| `csv`      | カンマ区切り値        |
| `markdown` | Markdown テーブル  |
