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

## コマンド

| コマンド        | 説明                                  |
| ----------- | ----------------------------------- |
| `認証`        | ログイン、ログアウト、ステータス確認、デフォルトのワークスペースの設定 |
| `workspace` | ワークスペースの一覧表示と確認                     |
| `プロジェクト`    | プロジェクトの一覧表示、取得、作成                   |
| `バージョン`     | データセットのバージョンの一覧表示、取得、ダウンロード、エクスポート  |
| `画像`        | 画像のアップロード、取得、検索、タグ付け、削除、アノテーション     |
| `model`     | 学習済みモデルの一覧表示、取得、アップロード              |
| `学習`        | モデルの学習を開始                           |
| `infer`     | 画像に対して推論を実行                         |
| `検索`        | ワークスペース内の画像を検索し、結果をエクスポート           |
| `デプロイ`      | 専用デプロイメントを管理                        |
| `ワークフロー`    | ワークフローを管理                           |
| `フォルダ`      | ワークスペースのフォルダを管理                     |
| `アノテーション`   | アノテーションのバッチとジョブ                     |
| `ユニバース`     | Roboflow Universe を検索               |
| `動画`        | 動画推論                                |
| `バッチ`       | バッチ処理ジョブ *(近日公開)*                   |
| `補完`        | シェル補完スクリプト（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` が次の間で区別されます `ワークスペース/プロジェクト` と `プロジェクト/バージョン`.

## 便利なエイリアス

一般的な操作には、短いトップレベルのエイリアスがあります：

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