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

# Phaseo CLI

> 公式 Phaseo CLI をインストールし、コーディング環境を設定して、ターミナルから Phaseo を管理します。

Phaseo CLI は `@phaseo/cli` として配布されています。コーディング環境を Phaseo に接続し、Phaseo コントロールプレーンを操作する公式のターミナルワークフローを提供します。

次の操作をしたい場合に使います。

* ローカルまたはリモートのシェル、エージェント実行環境から Phaseo ユーザーとしてサインインする
* API キーまたは管理キーを作成・ローテーションする
* ワークスペース、プリセット、設定、ガードレールを管理する
* ユーザー作成の OAuth アプリが非公開テスト中の間に、公式 CLI の OAuth を使う
* モデル、プロバイダー、料金、クレジット、アクティビティ、分析、生成を確認する

## インストール

<CodeGroup>
  ```bash title="npm" theme={null}
  npm install -g @phaseo/cli
  ```

  ```bash title="pnpm" theme={null}
  pnpm add -g @phaseo/cli
  ```

  ```bash title="yarn" theme={null}
  yarn global add @phaseo/cli
  ```

  ```bash title="bun" theme={null}
  bun add -g @phaseo/cli
  ```
</CodeGroup>

## インストール済みバージョンを確認する

```bash theme={null}
phaseo --version
phaseo version
phaseo version --json
```

* `phaseo --version` はインストール済みのバージョンを表示します。
* `phaseo version` はバージョンと、現在のパッケージマネージャーに推奨される更新コマンドを表示します。
* 新しいバージョンが公開されている場合、対話型実行では更新案内も表示されます。

以前の `phaseo` コマンドも互換性エイリアスとして引き続き使用できます。

## サインイン

まず次を実行します。

```bash theme={null}
phaseo login
```

CLI は 2 つの公式フローに対応しています。

* **Phaseo でサインイン**: 認可コードと PKCE を使ったブラウザー OAuth
* **デバイスコードでサインイン**: SSH、CI、ヘッドレスシェル、エージェント環境に最適

どちらかの方法を明示的に選ぶこともできます。

```bash theme={null}
phaseo login --browser
phaseo login --device-code
```

リモート環境や非対話型環境では、デバイスコードが自動的に優先されます。

## ターミナル出力

対話型ターミナルでは Phaseo の色や表示階層が使われ、セットアップ中は一時的なスピナーが表示されます。スピナーは `stderr` に出力され、処理完了時に行を消去します。TTY でない `stderr` と `TERM=dumb` はアニメーションを無効にし、`NO_COLOR` は色を無効にします。`--json` を使うコマンドは常に装飾のない構造化出力を返すため、エージェントや自動化に適しています。ターミナルラッパーが色に対応していても TTY として報告しない場合に限り、`FORCE_COLOR=1` を使用してください。

## 自分のアカウントを確認する

```bash theme={null}
phaseo whoami
phaseo whoami --json
```

現在の Phaseo ユーザー、スコープ、アクティブなワークスペース、利用可能なワークスペースを返します。

## キーを作成する

```bash theme={null}
phaseo keys create --name "Local CLI Key"
phaseo keys create --name "Agent Sandbox Key" --json
phaseo keys current
```

エージェントや自動化で作成したキーを一度だけ未加工の形式で取得する場合は、`--json` を使います。

## ワークスペースとガードレールを管理する

```bash theme={null}
phaseo workspaces list
phaseo workspaces members <workspace-id-or-slug>

phaseo guardrails list
phaseo guardrails create --name "Production Safety" --body-json '{"enabled":true}'
```

CLI から Phaseo ダッシュボードや管理 API の便利な機能を使えるようにします。

## 対応するコーディング環境を起動する

永続的な連携では製品名を直接使います。

```bash theme={null}
phaseo codex
phaseo claude-code
phaseo deepseek-harness
phaseo opencode
phaseo pi
phaseo prime-agent
phaseo openclaw
phaseo aider
phaseo roo-code
phaseo kilo-code
phaseo continue
phaseo cursor
phaseo zed
```

必要に応じて`--model`、`--catalog all|default`、`--dry-run`を使ってください。以前の`phaseo integrations setup <integration>`形式は互換性のため残っていますが、必須ではありません。

CLIは一時的なプロバイダー設定と専用のPhaseoキーでCline、Kilo Code、oh-my-pi、Muse Code、MiniMax Codeを起動できます。設定とトラブルシューティングについては各連携ガイドを参照してください：[Cline](./cline)、[Kilo Code](./kilo-code)、[oh-my-pi](./oh-my-pi)、[Muse Code](./muse-code)、[MiniMax Code](./minimax-code)。

```bash theme={null}
phaseo cline --model openai/gpt-5.6-terra -- --tui
phaseo kilo --model openai/gpt-5.6-terra --
phaseo omp --model openai/gpt-5.6-terra --
phaseo muse --model meta/muse-spark-1.3 --
phaseo minimax --model openai/gpt-5.6-terra --
```

明示的な形式は`phaseo run <cline|kilo|omp|muse|minimax>`です。Phaseoのオプションは`--`より前、コーディング環境のオプションは後に指定します。`--catalog all`ですべての有効なPhaseoテキスト/チャットモデルを同期できます。認証情報を作成せずにプレビューするには次を使います。

```bash theme={null}
phaseo cline --model openai/gpt-5.6-terra --dry-run --json
```

Cline、Kilo Code、oh-my-piが未インストールの場合は対話形式でインストールを案内します。Muse CodeとMiniMax Codeはコマンドがない場合に公式インストーラーを使います。WindowsのMiniMax Codeは公式PowerShellインストーラーを使います。環境を個別に管理する場合は`--skip-install`を指定してください。既存のCline、Kilo、oh-my-pi、Muse Code、MiniMax Code設定は上書きされません。

## OAuth アプリ

Phaseo は、公式 CLI、ユーザー作成アプリ、動的に登録された MCP クライアントで共通の OAuth 認可サーバーを使用します。CLI はブラウザーまたはデバイスコードでログインし、ローテーションするリフレッシュトークンを使います。サードパーティーのクライアントは、PKCE 付き認可コード、明示的なスコープとワークスペースの同意、取り消し可能な委任アクセストークン、必要に応じた保護リソースへのバインドを使用します。

ホスト版 Phaseo API ではサードパーティー OAuth が有効です。セルフホスト版やプレビュー版では、`PHASEO_THIRD_PARTY_OAUTH_ENABLED` に真の値を設定しない限り無効のままです。`1`、`true`、`yes`、`on` を受け付け、空白を除去した後、大文字と小文字を区別せず判定します。有効にするとユーザー作成 OAuth アプリの管理と動的クライアント登録が可能になるため、リダイレクト URI、同意、クライアントシークレット、レート制限、ワークスペース認可の設定を確認してください。

```bash title=".env" theme={null}
PHASEO_THIRD_PARTY_OAUTH_ENABLED=true
```

```bash title="Docker" theme={null}
docker run -e PHASEO_THIRD_PARTY_OAUTH_ENABLED=true phaseo
```

```yaml title="Kubernetes" theme={null}
env:
  - name: PHASEO_THIRD_PARTY_OAUTH_ENABLED
    value: "true"
```

## セキュリティモデル

CLI セッションでは既定で OS が提供する安全なストレージが必要です。OS の資格情報ストアがない場合に限り、明示的に `PHASEO_SESSION_BACKEND=file` を設定してください。この場合、リフレッシュトークンは権限を制限した平文ファイルに保存されます。

* `phaseo logout` はローカル状態を消去する前に、保存されたリフレッシュトークンを失効させます。
* 管理キーには明示的な機能権限が必要です。
* 通常の推論キーは、独立したスコープモデルではなく、ガードレール、ルーティングポリシー、ワークスペース設定に基づきます。

## 更新する

<CodeGroup>
  ```bash title="npm" theme={null}
  npm install -g @phaseo/cli@latest
  ```

  ```bash title="pnpm" theme={null}
  pnpm add -g @phaseo/cli@latest
  ```

  ```bash title="yarn" theme={null}
  yarn global add @phaseo/cli@latest
  ```

  ```bash title="bun" theme={null}
  bun add -g @phaseo/cli@latest
  ```
</CodeGroup>

## 次のステップ

* [管理 API キー](../../developers/management-api-keys.mdx)
* [認証](../../developers/authentication.mdx)
* [Codex](./codex.mdx)
* [Claude Code](./claude-code.mdx)
* [Cline](./cline)
* [Kilo Code](./kilo-code)
* [oh-my-pi](./oh-my-pi)
* [Muse Code](./muse-code)
* [MiniMax Code](./minimax-code)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.