ug CLI 參考

使用 Unity Gateway CLIug() 來設定並啟動程式代理程式。 想看攻略,請參考 coding agent 快速入門。

Install

安裝 ug,然後檢查已安裝的版本:

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

需要 uv Python 3.12 或更新版本。

Configure

命令 其功能是什麼
ug configure 登入 Azure Databricks 工作區,並使用管理員的設定或引導設定來設定你的代理程式。
ug configure --workspace https://your-workspace.databricks.com 設定你的代理程式使用指定的 URL 工作區。
ug configure --profile <name> --use-pat 用 個人存取權杖 來驗證,而不是 OAuth。 先執行databricks configure --host <workspace-url>將令牌儲存在設定檔中,然後用(例如)--profile DEFAULT傳遞該設定檔--profile。 該設定檔提供工作區的網址。

啟動代理

這些指令會開啟終端機中的代理程式,準備好進行平常的程式工作流程。

命令 其功能是什麼
ug 啟動由你管理員已發布的工作區設定所選擇的代理程式。
ug claude 透過 Unity Gateway 啟動 Claude 程式碼。
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 啟動游標特工。 模型請求會使用你的游標帳號。

對於 Claude Code 或 Codex,啟動前先更新 --refresh 工作區的認證、模型和設定。 你也可以將針對代理的參數傳給啟動指令。

MCP 伺服器

命令 其功能是什麼
ug mcp add 選擇 MCP 伺服器,並將其連線加入你設定的代理程式。
ug mcp list 顯示已設定的 MCP 伺服器以及每個代理回報的狀態。
ug mcp remove 選擇 MCP 連線以移除代理人員。 伺服器仍留在工作區。

Skills

命令 其功能是什麼
ug skills add 選擇已發表的技能,並將其檔案下載到本地的經紀人技能目錄。
ug skills add --via mcp 透過 MCP 連接選取的 Unity 目錄結構中的技能,無需下載檔案。
ug skills list 展示為你的客服人員配置的技能,以及這些技能是如何被加入的。
ug skills remove 選擇已下載的技能資料夾從電腦刪除。 已發表的技能保持不變。
ug skills remove --via mcp 從技能登錄的 MCP 連線中移除選取的結構。 下載的技能檔案會被保留。

關於命名伺服器與技能、結構選擇及專案下載,請參見 新增工具與技能。

管理你的設定

命令 其功能是什麼
ug usage 請顯示您目前的支出、總預算及使用百分比。
ug doctor 檢查你當地的安裝和代理程式設定,並針對發現的問題提供修正。
ug upgrade 從 GitHub 安裝最新的 Unity Gateway CLI 版本。
ug export 將管理員儲存的編碼代理設定列印成 JSON 以便重複使用。
ug revert 還原備份的代理程式設定檔並清除 ug已儲存的設定狀態。

指令協助

請使用 --help 以查看你已安裝版本的選項:

命令 其功能是什麼
ug --help 顯示可用指令和一般選項。
ug configure --help 顯示工作區和代理程式設定選項。
ug skills add --help 展示下載技能或透過 MCP 連接技能的選項。