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

# CLI ドキュメント

コマンドラインから音声エージェントを作成、デプロイ、管理します。

## インストール

<Warning>クイックインストールのコマンドを実行することにより、Cartesia の [利用規約 (TOS)](https://cartesia.ai/legal/terms.html) に同意したものとみなされます。続行する前に必ず利用規約の全文を確認してください。</Warning>

サーバーからインストールおよびダウンロードします：

```zsh lines theme={null}
curl -fsSL https://cartesia.sh | sh
```

最新バージョンへ更新します：

```zsh lines theme={null}
cartesia update
```

## クイックスタート

<Steps>
  <Step title="API キーでログイン">
    Cartesia API キーで認証します。
    API キーを作成するには [play.cartesia.ai/keys](https://play.cartesia.ai/keys) にアクセスし、組織を選択してください。

    ```zsh lines theme={null}
    cartesia auth login  # paste your API key when prompted
    ```
  </Step>

  <Step title="サンプルエージェントをクローン">
    Line リポジトリからサンプルエージェントをクローンします。

    ```zsh lines theme={null}
    cartesia create my-agent
    # Choose any example you like.
    cd my-agent
    ```
  </Step>

  <Step title="エージェントを初期化">
    エージェントに名前を付け、組織にリンクします。

    ```zsh lines theme={null}
    cartesia init
    ```
  </Step>

  <Step title="エージェントをデプロイ">
    エージェントをデプロイしてプレイグラウンドで利用できるようにします。

    ```zsh lines theme={null}
    cartesia deploy
    ```
  </Step>
</Steps>

## 機能

### プロジェクトの初期化

任意のディレクトリを新規または既存の Cartesia エージェントにリンクします：

```zsh lines theme={null}
cartesia init
```

サンプルからプロジェクトを作成します：

```zsh lines theme={null}
cartesia create
```

<Tip>
  プロジェクトディレクトリ内では、CLI が自動的にエージェントを検出します。現在のエージェント ID を確認するには `cartesia status` を実行します。
</Tip>

### エージェントとチャット

エージェントのテキスト推論をローカルでテストします。

ターミナル 1：テキストロジックの FastAPI サーバーを実行します。

```zsh lines theme={null}
PORT=8000 uv run python main.py
```

ターミナル 2：CLI を実行してエージェントとチャットします。

```zsh lines theme={null}
cartesia chat 8000
```

## コマンド

### 認証

API キーを取得するには、[play.cartesia.ai/keys](https://play.cartesia.ai/keys) にアクセスし、組織を選択して新しいキーを生成してください。

```zsh lines theme={null}
cartesia auth login
```

既存の API キーを検証します：

```zsh lines theme={null}
cartesia auth status
```

ログアウト（キャッシュされた認証情報をクリア）：

```zsh lines theme={null}
cartesia auth logout
```

### 音声エージェント

エージェントを Cartesia クラウドにデプロイします。

```zsh lines theme={null}
cartesia deploy
```

組織内のすべてのエージェントを一覧表示します：

```zsh lines theme={null}
cartesia agents ls
```

#### マネージドデプロイメント

Cartesia のクラウド上で実行されるエージェントのバージョンです。各デプロイメントは環境を再ビルドし、プロジェクトをインスタンス化し、ヘルスチェックを実行します。

すべてのデプロイメントを表示します：

```zsh lines theme={null}
cartesia deployments ls
```

デプロイメントのステータスを確認します：

```zsh lines theme={null}
cartesia status [<deployment-id> or <agent-id>]
```

#### セルフホスト型エージェントコード

Cartesia のマネージドデプロイメントは低レイテンシの音声エージェントをデプロイする最も簡単な方法ですが、エージェントコードのデプロイメントをご自身で管理したい場合は、通話中にエージェントが接続する URL を Cartesia に渡すこともできます。

既存のエージェントをセルフホスト型コードに接続します：

```zsh lines theme={null}
cartesia connect --agent-id <agent-id> --url https://my-agent.example.com
```

`--agent-id` を指定せずに実行すると、既存のエージェントを対話的に選択するか、新規作成できます：

```zsh lines theme={null}
cartesia connect --url https://my-agent.example.com
```

エージェントをセルフホスト型コードから切断します：

```zsh lines theme={null}
cartesia disconnect --agent-id <agent-id>
```

### 環境変数

エージェント用の環境変数を作成、一覧表示、削除します。

エージェントに環境変数を設定します：

```zsh lines theme={null}
cartesia env set API_KEY=FOOBAR MY_CONFIG=FOOBAZ
```

<Warning icon="lock">
  環境変数は保存時に暗号化され、お客様のコードからのみアクセスできます。
</Warning>

`.env` ファイルから環境変数を取り込みます：

```zsh lines theme={null}
cartesia env set --from .env
```

```text .env theme={null}
API_KEY=FOOBAR
MY_CONFIG=FOOBAZ
```

環境変数を削除します：

```zsh lines theme={null}
cartesia env rm <env-var-name>
```

### 電話番号

組織内のすべての電話番号を一覧表示します：

```zsh lines theme={null}
cartesia phone-numbers ls
```

プロバイダーの種類または割り当てられたエージェントでフィルタリングします：

```zsh lines theme={null}
cartesia phone-numbers ls --type twilio        # cartesia, twilio, or sip_trunk
cartesia phone-numbers ls --agent-id <agent-id>
```

特定の電話番号の詳細を取得します：

```zsh lines theme={null}
cartesia phone-numbers get <phone-number-id>
```

新しい Cartesia マネージドの電話番号をプロビジョニングします：

```zsh lines theme={null}
cartesia phone-numbers provision "Support Line"
cartesia phone-numbers provision "Support Line" --agent-id <agent-id>
```

電話番号をエージェントに割り当てます：

```zsh lines theme={null}
cartesia phone-numbers assign <phone-number-id> --agent-id <agent-id>
```

電話番号のエージェント割り当てを解除します：

```zsh lines theme={null}
cartesia phone-numbers unassign <phone-number-id>
```

電話番号のラベルを更新します：

```zsh lines theme={null}
cartesia phone-numbers update <phone-number-id> --label "New Label"
```

電話番号を削除します：

```zsh lines theme={null}
cartesia phone-numbers delete <phone-number-id>
```

<Note>
  Twilio や SIP トランクの番号をインポートするには、[プレイグラウンド](https://play.cartesia.ai/phone-numbers) または [Phone Numbers API](/api-reference/agents/phone-numbers/import) を使用してください。インポート後は、すべての番号を CLI で管理できます。
</Note>

### ヘルプメニュー

各コマンドの詳細を確認するには：

```zsh lines theme={null}
cartesia --help
```
