---
title: CLIの使用
url: https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/using
description: ant CLIのコマンド構造、出力形式、GJSON変換、リクエストボディ、およびデバッグについて説明します。
---

このページでは、すべてのエンドポイントに共通して適用される `ant` CLIの入出力の仕組みについて説明します。インストールと認証については、[クイックスタート](https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/quickstart)を参照してください。コマンドの連結やリソースのバージョン管理については、[CLIスクリプティングと自動化](https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/scripting)を参照してください。

## コマンド構造

コマンドは `resource action` パターンに従います。ネストされたリソースにはコロンを使用します。

```text wrap
ant <resource>[:<subresource>] <action> [flags]
```

リソースの完全な一覧を表示するには `ant --help` を実行してください。また、任意のサブコマンドに `--help` を付けると、そのフラグを確認できます。

ベータ版のリソース（agents、sessions、deployments、environmentsを含む）は `beta:` プレフィックスの下にあります。この名前空間のコマンドは、そのリソースに適切な `anthropic-beta` ヘッダーを自動的に送信するため、自分で渡す必要はありません。`--beta <header>` はデフォルトを上書きする場合（たとえば、別のスキーマバージョンをオプトインする場合）にのみ使用してください。

```bash
ant models list
ant messages create --model claude-opus-5-5 --max-tokens 1024 ...
ant beta:agents retrieve --agent-id agent_01...
ant beta:sessions:events list --session-id session_01...
```

### グローバルフラグ

| フラグ                                  | 説明                                                                                                                                                                                                                                                                                                                                                                   |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--profile`                          | この呼び出しで使用する名前付きプロファイル（`ANTHROPIC_PROFILE` の設定と同等）。[ワークスペース間の切り替え](https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/authentication#switch-between-workspaces)を参照してください。                                                                                                                                                                                     |
| `--format`                           | 出力形式：`auto`、`json`、`jsonl`、`yaml`、`pretty`、`raw`、`explore`                                                                                                                                                                                                                                                                                                           |
| `--transform`                        | [GJSONパス](https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/using#transform-output-with-gjson)でレスポンスをフィルタリングまたは整形します                                                                                                                                                                                                                                        |
| `-r`、`--raw-output`                  | `jq -r` のように、文字列の結果を引用符なしで出力します                                                                                                                                                                                                                                                                                                                                      |
| `--base-url`                         | APIのベースURLを上書きします                                                                                                                                                                                                                                                                                                                                                    |
| `--workspace-id`                     | 任意。複数のワークスペースにアクセスできるAPIキー向けに、`anthropic-workspace-id` ヘッダーとして送信するワークスペースID（`wrkspc_...`）（`ANTHROPIC_WORKSPACE_ID` の設定と同等）。[ワークスペースの選択](https://platform.claude.com/docs/ja/manage-claude/authentication#select-a-workspace)を参照してください。[Admin API](https://platform.claude.com/docs/ja/manage-claude/admin-api)のコマンドは独自の `--workspace-id` を取り、こちらは管理対象のワークスペースを指定します。 |
| `--debug`                            | 完全なHTTPリクエストとレスポンスをstderrに出力します                                                                                                                                                                                                                                                                                                                                      |
| `--format-error`、`--transform-error` | `--format` および `--transform` と同じですが、[エラーレスポンス](https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/scripting#inspect-errors)に適用されます                                                                                                                                                                                                                           |

## 出力形式

`auto` はJSONを整形して出力し、リソースを作成または変更するコマンドのデフォルトです。一覧取得（list）および取得（retrieve）コマンドは、ターミナルに出力する場合は[インタラクティブエクスプローラー](https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/using#interactive-explorer)が、パイプされた場合は整形済みJSONがデフォルトになります。いずれのデフォルトも `--format` で上書きできます。

```bash
ant models retrieve --model-id claude-opus-5-5 --format yaml
```

```yaml Output
type: model
id: claude-opus-5-5
display_name: Claude Opus 5.5
created_at: "2026-09-22T00:00:00Z"
...
```

一覧取得エンドポイントは自動的にページネーションを行います。デフォルトの形式では各アイテムが個別に書き出されるため（`jsonl` モードでは1行に1つのコンパクトなJSONオブジェクト、`yaml` モードではYAMLドキュメントのストリーム）、`head`、`grep`、および `--transform` フィルターにきれいにストリーミングできます。

### インタラクティブエクスプローラー

エクスプローラーは、大きなレスポンスを閲覧するための折りたたみ・検索機能付きのTUIです。矢印キーでノードを展開・折りたたみ、`/` で検索、`q` で終了します。一覧取得および取得コマンドは、ターミナルに接続されている場合にデフォルトでこれを開きます。明示的に開くには `--format explore` を渡します。

```bash
ant models list --format explore
```

## GJSONによる出力の変換

出力前にレスポンスを整形するには `--transform` を使用します。式は[GJSONパス](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)です。一覧取得エンドポイントでは、変換はエンベロープではなく各アイテムに対して個別に実行されます。

```bash
ant beta:agents list \
  --transform "{id,name,model}" \
  --format jsonl
```

```jsonl Output
{"id": "agent_011CYm1BLqPX...", "name": "Docs CLI Test Agent", "model": "claude-opus-5-5"}
{"id": "agent_011CYkVwfaEt...", "name": "Coffee Making Assistant", "model": "claude-opus-5-5"}
{"id": "agent_011CYixHhtUP...", "name": "Coding Assistant", "model": "claude-opus-5-5"}
```

### スカラー値の抽出

単一のフィールドを引用符なしの文字列として取得するには（たとえば、新しく作成したリソースのID）、`--transform` と `--raw-output` を組み合わせます。結果はJSONの引用符なしで出力され、そのままシェル変数に代入できます。

```bash
AGENT_ID=$(ant beta:agents create \
  --name "My Agent" \
  --model '{id: claude-opus-5-5}' \
  --transform id --raw-output)

printf '%s\n' "$AGENT_ID"
```

```text Output wrap
agent_011CYm1BLqPXpQRk5khsSXrs
```

<Note>
  `--raw-output` は `--format raw` とは異なります。`--raw-output` は `jq -r` のように、文字列の結果からJSONの引用符を取り除きます。`--format raw` は自動ページネーションを行わずにレスポンスボディの生のJSONバイトを出力します。一覧取得エンドポイントでは、`--transform` を各アイテムではなくページネーションのエンベロープに適用します。
</Note>

## リクエストボディの受け渡し

適切な入力方法はデータの形状によって異なります。スカラーフィールドや短い構造化値には**フラグ**を使用し、ネストされたボディや複数行のボディには**stdin**でドキュメントをパイプし、任意の文字列フィールドやバイナリフィールドにファイルの内容を取り込むに&#x306F;**`@file` 参照**を使用します。

### フラグ

スカラーフィールドはフラグに直接対応します。構造化フィールドは、緩やかなYAML風の構文（引用符なしのキー、文字列の引用符は任意）または厳密なJSONを受け付けます。

```bash
ant beta:sessions create \
  --agent '{type: agent, id: agent_011CYm1BLqPXpQRk5khsSXrs, version: 1}' \
  --environment-id env_01595EKxaaTTGwwY3kyXdtbs \
  --title "CLI docs test session"
```

繰り返し可能なフラグは配列を構築します。`--tool` または `--event` を指定するたびに要素が1つ追加されます。

```bash
ant beta:agents create \
  --name "Research Agent" \
  --model '{id: claude-opus-5-5}' \
  --tool '{type: agent_toolset_20260401}' \
  --tool '{type: custom, name: search_docs, input_schema: {type: object, properties: {query: {type: string}}}}'
```

### Stdin

JSONまたはYAMLドキュメントをstdinにパイプすると、リクエストボディ全体を指定できます。stdinからのフィールドはフラグとマージされ、フラグが優先されます。ここで `version` は以前の `retrieve` で返された楽観的ロックのトークンであり、`$AGENT_ID` は[スカラー値の抽出](https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/using#extract-a-scalar)と同様に取得したものです。

```bash
echo '{"description": "Updated test agent.", "version": 1}' | \
  ant beta:agents update --agent-id "$AGENT_ID"
```

ヒアドキュメントも同様に機能し、複数行のYAMLに便利です。ボディ内での変数展開を無効にするには、区切り文字を引用符で囲みます（`<<'YAML'` のように）。

```bash
ant beta:agents create <<'YAML'
name: Research Agent
model: claude-opus-5-5
system: |
  You are a research assistant. Cite sources for every claim.
tools:
  - type: agent_toolset_20260401
YAML
```

### ファイル参照

アップロードコマンドの `--file` のように、ファイルパスを取るフラグはそのままのパスを受け付けます。

```bash
ant files upload --file ./report.pdf
```

ファイルの内容を文字列値のフィールドにインライン展開するには、パスの前に `@` を付けます。

```bash
ant beta:agents create \
  --name "Researcher" --model '{id: claude-opus-5-5}' \
  --system @./prompts/researcher.txt
```

構造化されたフラグ値の内部では、パスを引用符で囲みます。Messages APIにPDFを送信するには次のようにします。

```bash
ant messages create \
  --model claude-opus-5-5 \
  --max-tokens 1024 \
  --message '{role: user, content: [
    {type: document, source: {type: base64, media_type: application/pdf, data: "@./scan.pdf"}},
    {type: text, text: "Extract the text from this scanned document."}
  ]}' \
  --transform 'content.#(type=="text").text' --raw-output
```

CLIはファイルタイプを検出し、バイナリファイルを自動的にbase64としてエンコードします。特定のエンコーディングを強制するには、プレーンテキストには `@file://`、base64には `@data://` を使用します。先頭のリテラルな `@` はバックスラッシュでエスケープします（`\@username`）。

## デバッグ

任意のコマンドに `--debug` を追加すると、正確なHTTPリクエストとレスポンス（ヘッダーとボディ）がstderrに出力されます。APIキーはマスクされます。

```bash
ant --debug beta:agents list
```

```text Output wrap
GET /v1/agents?beta=true HTTP/1.1
Host: api.anthropic.com
Anthropic-Beta: managed-agents-2026-04-01
Anthropic-Version: 2023-06-01
X-Api-Key: <REDACTED>
...
```

## 利用可能なリソース

CLIが公開するすべてのAPIリソースは、[APIリファレンス](https://platform.claude.com/docs/ja/api/cli/messages/create)に記載されています。ローカルで一覧を確認するには `ant --help` を実行し、任意のサブコマンドに `--help` を付けるとそのフラグとパラメータを確認できます。

## 次のステップ

<CardGroup cols={3}>
  <Card title="CLIスクリプティングと自動化" icon="code" href="https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/scripting">
    APIリソースのバージョン管理、スクリプティングパターン、およびClaude Codeからの利用
  </Card>

  <Card title="APIリファレンス" icon="book" href="https://platform.claude.com/docs/ja/api/cli/messages/create">
    エンドポイント固有のパラメータ、リクエストフィールド、およびレスポンススキーマ
  </Card>

  <Card title="CLI認証オプション" icon="lock" href="https://platform.claude.com/docs/ja/cli-sdks-libraries/cli/authentication">
    APIキー、ヘッドレスホスト、複数のワークスペース、および名前付きプロファイル
  </Card>
</CardGroup>