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

# CLI

> ターミナルから Avala リソースを管理しましょう

Avala CLI を使えば、データセットの一覧表示、エクスポートの作成、クラウドストレージの管理などをコマンドラインから直接行えます。

## インストール

<CodeGroup>
  ```bash Recommended theme={null}
  curl -fsSL https://avala.ai/install.sh | bash
  ```

  ```bash pip theme={null}
  pip install avala[cli]
  ```
</CodeGroup>

インストールスクリプトは Python のバージョンを検出し、pip 経由で `avala[cli]` をインストールし、セットアップを検証します。Python 3.9+ が必要です。

これにより、`avala` コマンドが [Click](https://click.palletsprojects.com/) と [Rich](https://rich.readthedocs.io/) と共にインストールされ、フォーマットされたターミナル出力が提供されます。

## 認証

API キーを環境変数として設定します（推奨）：

```bash theme={null}
export AVALA_API_KEY="avk_your_api_key"
```

またはコマンドにフラグとして渡すこともできます：

```bash theme={null}
avala --api-key avk_your_api_key datasets list
```

対話的に認証情報を設定するには：

```bash theme={null}
avala configure
```

API キーとベース URL の入力を案内し、シェルプロファイルに追加する `export` ステートメントを出力します。

## グローバルオプション

| オプション             | 説明                                                                              |
| ----------------- | ------------------------------------------------------------------------------- |
| `--api-key TEXT`  | Avala API キー（または `AVALA_API_KEY` 環境変数を設定）。                                      |
| `--base-url TEXT` | API ベース URL（または `AVALA_BASE_URL` 環境変数を設定）。デフォルト: `https://api.avala.ai/api/v1`。 |
| `--help`          | コマンドのヘルプを表示。                                                                    |

## コマンド

### datasets

```bash theme={null}
# すべてのデータセットを一覧表示
avala datasets list

# 結果を制限
avala datasets list --limit 10

# 特定のデータセットを取得
avala datasets get <uid>
```

**`list` オプション:**

| オプション             | 説明       |
| ----------------- | -------- |
| `--limit INTEGER` | 返す最大結果数。 |

**`get` 出力フィールド:** UID, Name, Slug, Items, Type, Created, Updated。

***

### projects

```bash theme={null}
# すべてのプロジェクトを一覧表示
avala projects list

# 特定のプロジェクトを取得
avala projects get <uid>
```

**`list` オプション:**

| オプション             | 説明       |
| ----------------- | -------- |
| `--limit INTEGER` | 返す最大結果数。 |

**`get` 出力フィールド:** UID, Name, Status, Created, Updated。

***

### tasks

```bash theme={null}
# すべてのタスクを一覧表示
avala tasks list

# 結果を制限
avala tasks list --limit 50

# 特定のタスクを取得
avala tasks get <uid>
```

**`list` オプション:**

| オプション             | 説明       |
| ----------------- | -------- |
| `--limit INTEGER` | 返す最大結果数。 |

**`get` 出力フィールド:** UID, Name, Type, Status, Project, Created, Updated。

***

### exports

```bash theme={null}
# すべてのエクスポートを一覧表示
avala exports list

# エクスポートの詳細を取得
avala exports get <uid>

# 新しいエクスポートを作成
avala exports create --project <uid>
avala exports create --dataset <uid>
```

**`create` オプション:**

| オプション            | 説明                  |
| ---------------- | ------------------- |
| `--dataset TEXT` | エクスポートするデータセット UID。 |
| `--project TEXT` | エクスポートするプロジェクト UID。 |

***

### storage-configs

クラウドストレージ接続（AWS S3、Google Cloud Storage）を管理します。

```bash theme={null}
# ストレージ設定を一覧表示
avala storage-configs list

# S3 バケットを追加
avala storage-configs create \
  --name "Production S3" \
  --provider aws_s3 \
  --s3-bucket-name my-bucket \
  --s3-bucket-region us-west-1 \
  --s3-access-key-id $AWS_ACCESS_KEY_ID \
  --s3-secret-access-key $AWS_SECRET_ACCESS_KEY

# GCS バケットを追加
avala storage-configs create \
  --name "Production GCS" \
  --provider gc_storage \
  --gc-bucket-name my-gcs-bucket \
  --gc-auth-json '{"type":"service_account",...}'

# ストレージ接続をテスト
avala storage-configs test <uid>

# ストレージ設定を削除（確認プロンプト付き）
avala storage-configs delete <uid>
```

**`create` オプション:**

| オプション               | 説明                             |
| ------------------- | ------------------------------ |
| `--name TEXT`       | ストレージ設定の名前（必須）。                |
| `--provider CHOICE` | `aws_s3` または `gc_storage`（必須）。 |

**AWS S3 オプション:**

| オプション                         | 説明                        |
| ----------------------------- | ------------------------- |
| `--s3-bucket-name TEXT`       | S3 バケット名。                 |
| `--s3-bucket-region TEXT`     | AWS リージョン（例：`us-west-1`）。 |
| `--s3-bucket-prefix TEXT`     | オブジェクトキープレフィックス。          |
| `--s3-access-key-id TEXT`     | AWS アクセスキー ID。            |
| `--s3-secret-access-key TEXT` | AWS シークレットアクセスキー。         |

**Google Cloud Storage オプション:**

| オプション                   | 説明                   |
| ----------------------- | -------------------- |
| `--gc-bucket-name TEXT` | GCS バケット名。           |
| `--gc-prefix TEXT`      | オブジェクトキープレフィックス。     |
| `--gc-auth-json TEXT`   | サービスアカウント JSON 認証情報。 |

***

### agents

自動化エージェントを管理します。

```bash theme={null}
# エージェントを一覧表示
avala agents list

# エージェントの詳細を取得
avala agents get <uid>

# エージェントを作成
avala agents create \
  --name "QA Bot" \
  --events "task.completed,result.submitted" \
  --callback-url https://example.com/hook

# エージェントを削除（確認プロンプト付き）
avala agents delete <uid>

# エージェントの実行を一覧表示
avala agents executions <uid>

# エージェントをテスト
avala agents test <uid>
```

***

### webhooks

ウェブフックサブスクリプションを管理します。

```bash theme={null}
# ウェブフックを一覧表示
avala webhooks list

# ウェブフックの詳細を取得
avala webhooks get <uid>

# ウェブフックを作成
avala webhooks create \
  --target-url https://example.com/webhook \
  --events "task.completed,export.ready"

# ウェブフックを削除（確認プロンプト付き）
avala webhooks delete <uid>

# ウェブフックをテスト
avala webhooks test <uid>

# ウェブフック配信を一覧表示
avala webhooks deliveries
```

***

### fleet

<Info>
  フリートコマンドはプレビュー版です。ここで説明するコマンドは変更される可能性があります。
</Info>

フリートデバイス、レコーディング、イベント、ルール、アラートを管理します。

```bash theme={null}
# オンラインデバイスを一覧表示
avala fleet devices list --status online

# 新しいデバイスを登録
avala fleet devices register --name "robot-arm-01" --type manipulator --firmware "2.4.1"

# デバイスのレコーディングを一覧表示
avala fleet recordings list --device dev_abc123 --since 7d

# タイムラインイベントを作成
avala fleet events create --recording rec_abc123 --type anomaly --label "Gripper force spike"

# レコーディングルールを一覧表示
avala fleet rules list

# アクティブなアラートを一覧表示
avala fleet alerts list --status open
```

***

### configure

CLI 認証情報の対話的セットアップウィザード。

```bash theme={null}
avala configure
```

API キーとベース URL の入力を促し、シェルプロファイル（`~/.bashrc`、`~/.zshrc` など）に追加する `export` コマンドを出力します。

## 使用例

### データセットの一覧表示とプロジェクトのエクスポート

```bash theme={null}
# 保有データセットを確認
avala datasets list

# プロジェクトからアノテーションをエクスポート
avala exports create --project proj_abc123

# エクスポートステータスを確認
avala exports get exp_xyz789
```

### クラウドストレージのセットアップ

```bash theme={null}
# S3 バケットを接続
avala storage-configs create \
  --name "Training Data" \
  --provider aws_s3 \
  --s3-bucket-name ml-training-data \
  --s3-bucket-region us-east-1 \
  --s3-access-key-id $AWS_ACCESS_KEY_ID \
  --s3-secret-access-key $AWS_SECRET_ACCESS_KEY

# 接続の動作確認
avala storage-configs test sc_abc123
```

### CI/CD での使用

```bash theme={null}
# CI パイプライン内で
export AVALA_API_KEY="${AVALA_API_KEY}"

# エクスポートをトリガーして UID をキャプチャ
avala exports create --project proj_abc123
```

## 環境変数

| 変数               | 説明                | デフォルト                         |
| ---------------- | ----------------- | ----------------------------- |
| `AVALA_API_KEY`  | Avala API キー。     | 必須                            |
| `AVALA_BASE_URL` | API ベース URL の上書き。 | `https://api.avala.ai/api/v1` |

## 出力フォーマット

CLI は [Rich](https://rich.readthedocs.io/) を使用してフォーマットされた出力を提供します：

* **リストコマンド**はフォーマットされたテーブルで結果を表示します。
* **取得コマンド**はキー・バリューの詳細ビューを表示します。
* **作成/削除コマンド**は確認メッセージを出力します。

出力がパイプされたりリダイレクトされたりすると、色とフォーマットは自動的に無効になります。

<Note>
  CLI は現時点で `--output json` や `--format` フラグをサポートしていません。すべての出力はターミナルでの読みやすさを重視してフォーマットされています。機械可読な出力が必要な場合は、[Python SDK](/docs/ja/sdks/python) または [REST API](/docs/sdks/rest-api) を直接使用してください。
</Note>