ug CLI リファレンス

Unity Gateway CLI（ug）を使用して、コーディングエージェントを構成して起動します。手順については、コーディングエージェントのクイックスタートを参照してください。

インストール

Install ug, then check the installed version:

Bash

uv tool install git+https://github.com/databricks/unity-gateway
ug --version

For requirements, see the quickstart prerequisites.

構成

コマンド	What it does
ug configure	Databricksワークスペースにサインインし、管理者の設定またはガイド付きセットアップを使用してエージェントを構成します。
ug configure --workspace https://your-workspace.databricks.com	指定されたURLのワークスペースを使用するようにエージェントを設定します。
ug configure --profile <name> --use-pat	OAuthの代わりにアクセストークンを使用して認証します。まずdatabricks configure --host <workspace-url>を実行してトークンを構成プロファイルに保存し、--profileを指定してそのプロファイルを渡します（例：--profile DEFAULT）。プロファイルにはワークスペースURLが指定されます。

コマンド	What it does
ug configure	Databricksワークスペースにサインインし、管理者の設定またはガイド付きセットアップを使用してエージェントを構成します。
ug configure --workspace https://your-workspace.databricks.com	指定されたURLのワークスペースを使用するようにエージェントを設定します。
ug configure --profile <name> --use-pat	OAuthの代わりにアクセストークンを使用して認証します。まずdatabricks configure --host <workspace-url>を実行してトークンを構成プロファイルに保存し、--profileを指定してそのプロファイルを渡します（例：--profile DEFAULT）。プロファイルにはワークスペースURLが指定されます。

エージェントを起動する

These コマンド open the agent in your terminal, ready for your usual coding ワークフロー.

コマンド	What it does
ug	管理者の公開済みワークスペース構成によって選択されたエージェントを起動します。
ug claude	Launch Claude Code through Unity Gateway.
ug codex	Unity Gateway を介して Codex を起動します。
ug gemini	Unity Gatewayを介してGemini CLIを起動します。
ug opencode	Unity Gatewayを介してOpenCodeを起動します。
ug copilot	Unity Gateway を介して GitHub Copilot CLI を起動します。
ug pi	Unity Gatewayを介してPiを起動します。
ug cursor	Cursor Agentを起動します。モデルのリクエストには、Cursorアカウントが使用されます。

コマンド	What it does
ug	管理者の公開済みワークスペース構成によって選択されたエージェントを起動します。
ug claude	Launch Claude Code through Unity Gateway.
ug codex	Unity Gateway を介して Codex を起動します。
ug gemini	Unity Gatewayを介してGemini CLIを起動します。
ug opencode	Unity Gatewayを介してOpenCodeを起動します。
ug copilot	Unity Gateway を介して GitHub Copilot CLI を起動します。
ug pi	Unity Gatewayを介してPiを起動します。
ug cursor	Cursor Agentを起動します。モデルのリクエストには、Cursorアカウントが使用されます。

Claude CodeまたはCodexの場合は、起動する前に--refreshを追加して、ワークスペースの認証、モデル、構成を更新してください。起動コマンドにエージェント固有の引数を渡すこともできます。

MCPサーバー

コマンド	What it does
ug mcp add	Select MCP servers and add their connections to your configured agents.
ug mcp list	設定されたMCPサーバーと、各エージェントによって報告されたステータスを表示します。
ug mcp remove	エージェントから削除する MCP 接続を選択します。サーバーはワークスペースに残ります。

コマンド	What it does
ug mcp add	Select MCP servers and add their connections to your configured agents.
ug mcp list	設定されたMCPサーバーと、各エージェントによって報告されたステータスを表示します。
ug mcp remove	エージェントから削除する MCP 接続を選択します。サーバーはワークスペースに残ります。

スキル

コマンド	What it does
ug skills add	公開済みのスキルを選択し、そのファイルをローカルのエージェント スキル ディレクトリにdownloadします。
ug skills add --via mcp	Connect skills from selected Unity Catalog schemas through MCP, without downloading files.
ug skills list	エージェントに設定されているスキルと、それらが追加された方法を表示します。
ug skills remove	コンピュータから削除する、downloadしたスキルフォルダを選択します。公開済みのスキルは変更されません。
ug skills remove --via mcp	スキルレジストリのMCP接続から選択したスキーマを削除します。ダウンロードしたスキルファイルは保持されます。

コマンド	What it does
ug skills add	公開済みのスキルを選択し、そのファイルをローカルのエージェント スキル ディレクトリにdownloadします。
ug skills add --via mcp	Connect skills from selected Unity Catalog schemas through MCP, without downloading files.
ug skills list	エージェントに設定されているスキルと、それらが追加された方法を表示します。
ug skills remove	コンピュータから削除する、downloadしたスキルフォルダを選択します。公開済みのスキルは変更されません。
ug skills remove --via mcp	スキルレジストリのMCP接続から選択したスキーマを削除します。ダウンロードしたスキルファイルは保持されます。

名前付きサーバーとスキル、スキーマ選択、プロジェクトのdownloadについては、ツールとスキルの追加を参照してください。

セットアップを管理します

コマンド	What it does
ug usage	適用可能な支出制限と使用率を表示します。使用状況の確認を参照してください。
ug doctor	ローカルのインストールとエージェント構成を確認し、見つかった問題に対する修正を提案します。
ug upgrade	GitHubから最新のUnity Gateway CLIバージョンをインストールします。
ug export	再利用できるように、管理者が保存したコーディングエージェントの構成を JSON として出力します。
ug revert	Restore backed-up agent configuration files and clear ug's saved setup state.

コマンド	What it does
ug usage	適用可能な支出制限と使用率を表示します。使用状況の確認を参照してください。
ug doctor	ローカルのインストールとエージェント構成を確認し、見つかった問題に対する修正を提案します。
ug upgrade	GitHubから最新のUnity Gateway CLIバージョンをインストールします。
ug export	再利用できるように、管理者が保存したコーディングエージェントの構成を JSON として出力します。
ug revert	Restore backed-up agent configuration files and clear ug's saved setup state.

使用状況を確認する

適用される Unity Gateway の利用制限を表示します。

コマンド	What it does
ug usage	適用可能な支出制限を最大 5 つ表示します。使用率の高い順に並べ替えられます。
ug usage --all	すべての適用可能な支出制限を同じ順序で表示します。

コマンド	What it does
ug usage	適用可能な支出制限を最大 5 つ表示します。使用率の高い順に並べ替えられます。
ug usage --all	すべての適用可能な支出制限を同じ順序で表示します。

各エントリーには、短い予算IDと以下のいずれかのラベルが含まれています。

ラベル	表示内容
月間個人制限	その月の予算のユーザー単位のthresholdに対する使用量。
毎月の共有制限	予算の対象となるユーザーによる、その月の共有thresholdに対する合計使用量。
1 日あたりの個人制限	その日の予算のユーザーごとのthresholdに対する使用量。
1日あたりの共有制限	予算でカバーされているユーザー全体での結合使用量と、その日の共有thresholdとの比較。

ラベル	表示内容
月間個人制限	その月の予算のユーザー単位のthresholdに対する使用量。
毎月の共有制限	予算の対象となるユーザーによる、その月の共有thresholdに対する合計使用量。
1 日あたりの個人制限	その日の予算のユーザーごとのthresholdに対する使用量。
1日あたりの共有制限	予算でカバーされているユーザー全体での結合使用量と、その日の共有thresholdとの比較。

支出は、複数の適用可能な制限にカウントされる場合があります。単一の予算に複数の制限を含めることができるため、複数のエントリで予算IDを共有できます。

予算とthresholdの情報については、「 Unity Gatewayの予算を管理する」を参照してください。

コマンドのヘルプ

インストールされているバージョンのオプションを表示するには、--help を使用します。

コマンド	What it does
ug --help	利用可能なコマンドと一般的なオプションを表示します。
ug configure --help	ワークスペースとエージェントのセットアップオプションを表示します。
ug skills add --help	スキルの download または MCP を介した接続のオプションを表示します。

コマンド	What it does
ug --help	利用可能なコマンドと一般的なオプションを表示します。
ug configure --help	ワークスペースとエージェントのセットアップオプションを表示します。
ug skills add --help	スキルの download または MCP を介した接続のオプションを表示します。