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

# AIHubMix CLI（コマンドラインツール）

> AIHubMix CLI は AIHubMix 公式のコマンドラインツールです。単一バイナリ・ゼロ依存で、ターミナルからアカウント残高の照会・API Key の管理・利用可能モデルの確認が行え、スクリプトや AI Agent との連携にも適しています。

**AIHubMix CLI** は AIHubMix 公式のコマンドラインツール（実行ファイル `aihubmix`）です。インストールすれば、ウェブコンソールを開かずに、ターミナルからアカウント残高の照会・API Key の管理・利用可能モデルの確認が行えます。単一バイナリで、**Python・Node・Go のインストールは不要**、1 つのコマンドでインストールできます。すべてのコマンドが JSON 出力に対応しており、スクリプト・CI・AI Agent（Claude Code など）にそのまま組み込めます。

**できること：**

* **残高照会**：アカウント残高と利用済み額をリアルタイムで照会
* **Key 管理**：API Key の作成・閲覧・検索・変更・削除
* **モデル確認**：現在のトークンで利用可能なモデルを一覧表示
* **スクリプト化**：JSON 出力 + 安定した終了コードで、自動化や AI Agent との連携に最適

<Info>
  **2 種類の認証情報を混同しないでください**：CLI は「システムアクセストークン」（Manage Key、形式 `fd***`）でログインします。コンソール [console.aihubmix.com/setting](https://console.aihubmix.com/setting) で「システムアクセストークンを生成」をクリックして取得してください。これは**アカウントの管理**に使用するもので、モデル呼び出しに使う API Key（`sk-***`）とは別物です。
</Info>

<Tip>
  旧バージョンの Python スクリプト（`aihubmix_cli.py`）をお探しですか？[インターフェースを介したアカウント情報の取得](/jp/api/Cli) をご参照ください。本ページはその次世代の代替品で、よりシンプルかつ高速です。
</Tip>

## インストール

### ワンクリックインストール（推奨）

ご利用のシステムに対応したコマンドをコピーしてターミナルで実行すると、バイナリがダウンロードされ自動的に `PATH` に追加されます：

<CodeGroup>
  ```bash macOS / Linux theme={null}
  curl -fsSL https://raw.githubusercontent.com/AIhubmix/platfrom-cli/main/install.sh | sh
  ```

  ```powershell Windows PowerShell theme={null}
  irm https://raw.githubusercontent.com/AIhubmix/platfrom-cli/main/install.ps1 | iex
  ```
</CodeGroup>

インストール後は**ターミナルを開き直し**、`aihubmix login` を実行すれば利用を開始できます。

<Info>
  [Releases](https://github.com/AIhubmix/platfrom-cli/releases) から対応プラットフォームのバイナリを手動でダウンロードすることもできます（Windows は `aihubmix_windows_amd64.exe`）。`PATH` のディレクトリに配置してください。Unix 系では `chmod +x` が必要です。
</Info>

必要に応じて、環境変数でインストール動作を調整できます：

| 変数                 | 説明                           | デフォルト                                                                          |
| ------------------ | ---------------------------- | ------------------------------------------------------------------------------ |
| `AIHUBMIX_VERSION` | 指定したバージョンをインストール（例：`v0.2.0`） | `latest`                                                                       |
| `AIHUBMIX_BIN_DIR` | インストールディレクトリをカスタマイズ          | Unix：`/usr/local/bin` または `~/.local/bin`；Windows：`%LOCALAPPDATA%\aihubmix\bin` |

## クイックスタート

ログインすればすべてのコマンドが利用できます：

```bash theme={null}
# 1. ログイン：ブラウザでトークン生成ページを自動的に開き、Manage Key を貼り付け（入力は非表示）
aihubmix login

# 2. 現在の ID と残高を確認
aihubmix whoami

# 3. 完全なアカウント情報を確認
aihubmix me

# 4. API Key の一覧を取得
aihubmix keys list
```

## コマンド一覧

| コマンド                                | 説明                     |
| ----------------------------------- | ---------------------- |
| `aihubmix login`                    | ログイン（Manage Key を貼り付け） |
| `aihubmix logout`                   | ログアウト（ローカル認証情報を削除）     |
| `aihubmix whoami`                   | 現在のログイン ID と残高を表示      |
| `aihubmix me`                       | 完全なアカウント情報と残高を表示       |
| `aihubmix models list`              | 現在利用可能なモデルを表示          |
| `aihubmix keys list [--num N]`      | API Key の一覧を取得         |
| `aihubmix keys search <キーワード>`      | キーワードで Key を検索         |
| `aihubmix keys get <id>`            | 指定した Key の詳細を表示        |
| `aihubmix keys create [パラメータ]`      | 新しい Key を作成            |
| `aihubmix keys update <id> [パラメータ]` | Key を変更                |
| `aihubmix keys delete <id>`         | Key を削除                |

<Tip>
  任意のコマンドに `--help` を付けると完全なパラメータを確認できます。例：`aihubmix keys create --help`。
</Tip>

## よく使う操作

### API Key の管理

```bash theme={null}
# $10 の上限・特定モデルに限定した Key を作成
aihubmix keys create -n prod-key -q 10 -m "gpt-4o,claude-3.5-sonnet"

# 上限なし・無期限の Key を作成
aihubmix keys create -n ci-key -u

# Key の名前を変更（他の設定はそのまま）
aihubmix keys update 123 -n new-name

# Key を無効化
aihubmix keys update 123 --status 0

# Key を削除
aihubmix keys delete 123
```

`-q 10` はその Key の上限が \$10 であることを、`-u` は上限なしを意味します。削除はデフォルトで確認を求めますが、CI 環境では `--yes` を付けてスキップできます。

### スクリプト / AI Agent での利用

CLI は自動化に非常に適しており、CI・スクリプト・AI Agent（Claude Code など）から直接操作できます：

* **ログイン不要**：環境変数 `AIHUBMIX_TOKEN` または `--token` で Manage Key を渡すことで、対話的なログインをスキップできます（優先順位：`--token` > `AIHUBMIX_TOKEN` > 設定ファイル）。
* **JSON 出力**：任意のコマンドに `--json`（`-j`）を付けると、正常な結果は stdout、エラーは stderr に出力され、`jq` でのパースが容易です。
* **安定した終了コード**：スクリプトはこれに基づいて成否を判定できます。

```bash theme={null}
# 環境変数で操作し、すべての Key 名を抽出
AIHUBMIX_TOKEN=fd*** aihubmix keys list --json | jq '.data[].name'

# 残高を照会
AIHUBMIX_TOKEN=fd*** aihubmix whoami --json | jq -r '.balance'
```

終了コードの意味：

| 終了コード | 意味                     |
| ----- | ---------------------- |
| `0`   | 成功                     |
| `1`   | 一般エラー（パラメータエラー、業務失敗など） |
| `2`   | 認証失敗（未ログイン / トークン無効）   |
| `3`   | ネットワーク / 接続エラー         |

## グローバルパラメータ

以下のパラメータはすべてのコマンドに適用されます：

| パラメータ              | 短縮形  | 説明                                            |
| ------------------ | ---- | --------------------------------------------- |
| `--token <token>`  | `-t` | Manage Key を直接渡す（CI / スクリプト向け）                |
| `--json`           | `-j` | JSON 形式で出力                                    |
| `--base-url <url>` | `-b` | API アドレスをカスタマイズ（デフォルト `https://aihubmix.com`） |
| `--no-color`       |      | カラー出力を無効化                                     |
| `--config <path>`  |      | 設定ファイルのパスを指定                                  |
| `--version`        |      | バージョンを表示                                      |

## 設定ファイル

ログイン情報は `~/.aihubmix/config.json`（Windows は `%USERPROFILE%\.aihubmix\config.json`）に保存され、権限は**現在のユーザーのみ読み書き可能**に制限されます。ログイン時の Manage Key は非表示で、ログにも記録されません。

<Warning>
  Manage Key をコードリポジトリにコミットしたり、他人と共有したりしないでください。漏洩した場合は、コンソールで再生成してください。古いトークンは即座に無効になります。
</Warning>

## よくある質問

**Python / Node / Go のインストールは必要ですか？**

不要です。CLI は単一バイナリで、ダウンロードすればすぐに使えます。

**Manage Key と API Key の違いは何ですか？**

Manage Key（`fd***`）はアカウントの管理（残高照会、Key 管理）に使用し、CLI で利用します。API Key（`sk-***`）はモデルの呼び出しに使用します。両者はコンソールの別々の場所で生成され、混用できません。

**Windows に対応していますか？**

対応しています。Windows・macOS・Linux すべてにネイティブバイナリを提供しています。

**CI / スクリプトで非対話的に使うには？**

環境変数 `AIHUBMIX_TOKEN` で Manage Key を渡し、`--json` と終了コードを組み合わせれば、`aihubmix login` を実行する必要はありません。

**Manage Key を忘れた / 漏洩した場合は？**

[console.aihubmix.com/setting](https://console.aihubmix.com/setting) で再生成してください。古いトークンは即座に無効になります。

***

*関連ドキュメント：[プラットフォーム API · CliEndpoints](/jp/api/CliEndpoints/get-self) · [旧バージョン Python スクリプト](/jp/api/Cli) · [AIHubMix コンソール](https://console.aihubmix.com)*

***

最終更新：2026-06-22