> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/reference/ja/platform/cli.md).

# CLI

Roboflow CLI コマンド、グローバルフラグ、JSON 出力、リソースの省略形、便利なエイリアスのリファレンス。

Roboflow PythonパッケージにはCLI（`pip install roboflow`）が含まれており、コマンドラインからRoboflowプラットフォームを操作するために使用できます。これは一貫した `roboflow <noun> <verb>` 形式に従っており、AIコーディングエージェントや自動化ツールで使用できる構造化JSON出力をサポートします。

## コマンド

<table data-search="false"><thead><tr><th>コマンド</th><th>説明</th></tr></thead><tbody><tr><td><code>auth</code></td><td>ログイン、ログアウト、ステータス確認、デフォルトワークスペースの設定</td></tr><tr><td><code>workspace</code></td><td>ワークスペースの一覧表示と詳細確認</td></tr><tr><td><code>project</code></td><td>プロジェクトの一覧表示、取得、作成</td></tr><tr><td><code>version</code></td><td>データセットのバージョンを一覧表示、取得、ダウンロード、エクスポート</td></tr><tr><td><code>image</code></td><td>画像をアップロード、取得、検索、タグ付け、削除、アノテーション</td></tr><tr><td><code>model</code></td><td>学習済みモデルを一覧表示、取得、アップロード</td></tr><tr><td><code>train</code></td><td>モデルの学習を開始</td></tr><tr><td><code>infer</code></td><td>画像に対して推論を実行</td></tr><tr><td><code>search</code></td><td>ワークスペース内の画像を検索し、結果をエクスポート</td></tr><tr><td><code>deployment</code></td><td>専用デプロイメントを管理</td></tr><tr><td><code>workflow</code></td><td>ワークフローを管理</td></tr><tr><td><code>folder</code></td><td>ワークスペースのフォルダを管理</td></tr><tr><td><code>annotation</code></td><td>アノテーションのバッチとジョブ</td></tr><tr><td><code>autolabel</code></td><td>基盤モデルまたはRoboflowモデルでバッチに自動ラベル付け</td></tr><tr><td><code>universe</code></td><td>Roboflow Universeを検索</td></tr><tr><td><code>video</code></td><td>動画推論</td></tr><tr><td><code>batch</code></td><td>実行と管理 <a href="https://docs.roboflow.com/deployment/roboflow-cloud/batch-processing#asset-library-images">Asset Libraryの画像に対するバッチ処理ジョブ</a></td></tr><tr><td><code>completion</code></td><td>シェル補完スクリプト（bash、zsh、fish）を生成</td></tr></tbody></table>

実行 `roboflow <command> --help` 各コマンドの詳細を確認するには。

## グローバルフラグ

これらのフラグはすべてのコマンドで機能し、サブコマンドの前後どちらにも指定できます：

<table data-search="false"><thead><tr><th>フラグ</th><th>短縮</th><th>説明</th></tr></thead><tbody><tr><td><code>--json</code></td><td><code>-j</code></td><td>結果を構造化JSONとして出力します（エージェントやパイプ処理向け）</td></tr><tr><td><code>--api-key</code></td><td><code>-k</code></td><td>APIキーの上書き</td></tr><tr><td><code>--workspace</code></td><td><code>-w</code></td><td>ワークスペースの上書き</td></tr><tr><td><code>--quiet</code></td><td><code>-q</code></td><td>進行バーとステータスメッセージを非表示にします</td></tr><tr><td><code>--version</code></td><td></td><td>パッケージのバージョンを表示</td></tr></tbody></table>

## エージェント向けJSON出力

すべてのコマンドは `--json` をサポートしており、パイプ処理やプログラムによる解析に安全な構造化出力を提供します：

```bash
roboflow --json project list | jq '.[0].id'
```

JSONモードでのエラーはstderrに出力され、stdoutは空になるため、パイプ処理に安全です：

```bash
roboflow --json project get nonexistent 2>error.json
# stdoutは空で、stderrには次が含まれます: {"error": {"message": "...", "hint": "..."}}
```

終了コードは一貫しています: 0 = 成功、1 = エラー、2 = 認証エラー、3 = 見つかりません。

## リソースの省略表記

リソースは簡潔な識別子で指定できます：

<table data-search="false"><thead><tr><th>省略表記</th><th>意味</th></tr></thead><tbody><tr><td><code>my-project</code></td><td>デフォルトのワークスペースを使用します</td></tr><tr><td><code>my-ws/my-project</code></td><td>明示的なワークスペース</td></tr><tr><td><code>my-project/3</code></td><td>デフォルトのワークスペース、バージョン3</td></tr><tr><td><code>my-ws/my-project/3</code></td><td>明示的なワークスペース、バージョン3</td></tr></tbody></table>

バージョン番号は常に数値なので、 `x/y` y が数値の場合はプロジェクトのバージョンを識別し、 `y` それ以外の場合はWorkspace/projectのペアを識別します。

## 便利なエイリアス

よく使う操作には短いトップレベルのエイリアスがあります：

<table data-search="false"><thead><tr><th>エイリアス</th><th>対応</th></tr></thead><tbody><tr><td><code>roboflow login</code></td><td><code>roboflow auth login</code></td></tr><tr><td><code>roboflow whoami</code></td><td><code>roboflow auth status</code></td></tr><tr><td><code>roboflow upload</code></td><td><code>roboflow image upload</code></td></tr><tr><td><code>roboflow download</code></td><td><code>roboflow version download</code></td></tr></tbody></table>
