> 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/purattofmu/cli.md).

# CLI

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

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

## コマンド

| コマンド         | 説明                                  |
| ------------ | ----------------------------------- |
| `auth`       | ログイン、ログアウト、ステータス確認、デフォルトのワークスペースを設定 |
| `workspace`  | ワークスペースの一覧表示と確認                     |
| `project`    | プロジェクトの一覧表示、取得、作成                   |
| `version`    | データセットバージョンの一覧表示、取得、ダウンロード、エクスポート   |
| `image`      | 画像のアップロード、取得、検索、タグ付け、削除、注釈付け        |
| `model`      | 学習済みモデルの一覧表示、取得、アップロード              |
| `train`      | モデルの学習を開始                           |
| `infer`      | 画像に対して推論を実行                         |
| `search`     | ワークスペース内の画像を検索し、結果をエクスポート           |
| `deployment` | 専用デプロイメントを管理                        |
| `workflow`   | ワークフローを管理                           |
| `folder`     | ワークスペースのフォルダを管理                     |
| `annotation` | 注釈バッチとジョブ                           |
| `autolabel`  | 基盤モデルまたは Roboflow モデルでバッチに自動ラベル付け   |
| `universe`   | Roboflow Universe を検索               |
| `video`      | 動画推論                                |
| `batch`      | バッチ処理ジョブ *（近日公開）*                   |
| `completion` | シェル補完スクリプト（bash、zsh、fish）を生成        |

実行 `roboflow <command> --help` を実行して、各コマンドの詳細を確認してください。

## グローバルフラグ

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

| フラグ           | 短縮形  | 説明                                |
| ------------- | ---- | --------------------------------- |
| `--json`      | `-j` | 結果を構造化 JSON として出力（エージェントやパイプ処理向け） |
| `--api-key`   | `-k` | API キーの上書き                        |
| `--workspace` | `-w` | ワークスペースの上書き                       |
| `--quiet`     | `-q` | 進行状況バーとステータスメッセージを非表示にする          |
| `--version`   |      | パッケージのバージョンを表示                    |

## エージェント向けの 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 = 見つかりません。

## リソースの省略記法

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

| 省略記法                 | 意味                    |
| -------------------- | --------------------- |
| `my-project`         | デフォルトのワークスペースを使用      |
| `my-ws/my-project`   | 明示的なワークスペース           |
| `my-project/3`       | デフォルトのワークスペース、バージョン 3 |
| `my-ws/my-project/3` | 明示的なワークスペース、バージョン 3   |

バージョン番号は常に数値です。これにより `x/y` が次の間で区別されます `workspace/project` と `project/version`.

## 便利なエイリアス

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

| エイリアス               | 対応                          |
| ------------------- | --------------------------- |
| `roboflow login`    | `roboflow auth login`       |
| `roboflow whoami`   | `roboflow auth status`      |
| `roboflow upload`   | `roboflow image upload`     |
| `roboflow download` | `roboflow version download` |