ug CLI 參考

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

Install

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

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

關於需求,請參考 快速入門的先決條件。

Configure

命令 其功能是什麼
ug configure 登入 Azure Databricks 工作區,並使用管理員的設定或引導設定來設定你的代理程式。
ug configure --workspace https://your-workspace.databricks.com 設定你的代理程式使用指定的 URL 工作區。
ug configure --agents claude,codex 無需提示即可設定所列代理。 若要新增 MCP 伺服器,請加上 --mcp 它們完整的 Unity 目錄名稱。 請直接參見 新增 MCP 伺服器。
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 工作區的認證、模型和設定。 你也可以將針對代理的參數傳給啟動指令。

要啟動特定模型代理,例如腳本,請加入 --model 該模型的完整 Unity 目錄名稱。 此方法適用於 ug claude、 ug codex、 ug copilot及 :

ug claude --model <full-model-name>

在代理啟動後,若要互動式選擇模型,請輸入 /model。

MCP 伺服器

關於伺服器選擇器、其他 Azure Databricks MCP 伺服器,以及其他 MCP 用戶端的設定,請參見「新增工具與技能」。

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

直接新增 MCP 伺服器

若要新增沒有 Picker 的 MCP 伺服器,請將其完整的 Unity 目錄名稱<catalog>.<schema>.<server-name>()傳送至 --names:

ug mcp add --names system.ai.github,system.ai.slack

同一指令的名稱必須在同一架構中。 否則, ug 會傳回錯誤。 若要從另一個結構新增伺服器,請再次執行 ug mcp add :

ug mcp add --names "<catalog>.<schema>.<server-name>"

要在結構中新增所有 MCP 伺服器:

ug mcp add --location "<catalog>.<schema>"

預設情況下,會 ug mcp add 將伺服器加入你設定的每個代理,且不會移除現有連線。 若要僅將伺服器加入特定代理,請新增 --agents:

ug mcp add --agents claude,codex --names system.ai.github

若要設定代理並新增其 MCP 伺服器,只需一個指令,請使用 ug configure :--mcp

ug configure --agents claude --mcp system.ai.github,system.ai.slack

用平常 ug 指令重新啟動代理程式,然後執行 ug mcp list 檢查連線狀況。

為所有開發者(管理員)新增 MCP 伺服器

工作區管理員可以透過 編碼代理設定為工作空間中的每位開發者新增 MCP 伺服器。 若要包含來自多個結構的伺服器,請在配置頂層列出它們的全名 mcp_servers.names :

{
  "mcp_servers": {
    "names": ["system.ai.github", "<catalog>.<schema>.<server-name>"]
  }
}

若要將所有 MCP 伺服器納入同一個架構,請將 設 unity_catalog_location 為 <catalog>.<schema> 而非 names。 如需詳細資訊,請參閱 mcp_servers。

開發者會跑來 ug configure 同步伺服器到他們的代理。 他們可以新增更多伺服器, ug mcp add這會跳過工作區設定已經提供的伺服器。

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已儲存的設定狀態。

檢查你的使用情況

查看適用於您的 Unity Gateway 支出上限。

命令 其功能是什麼
ug usage 顯示最多五個適用的支出上限,依使用百分比由高到低排序。
ug usage --all 請依照相同順序顯示所有適用的支出上限。

每條目都包含簡短的預算編號及以下標籤之一:

標籤 它顯示的內容
每月個人限額 你每月的使用量與預算的每用戶門檻相符。
每月共享上限 預算涵蓋的用戶總使用量,相較於當月共享門檻。
每日個人上限 你的使用量與預算中每日每位使用者的門檻相符。
每日共享限額 預算涵蓋的用戶總使用量,相較於當天共享門檻。

您的支出可以計入多個適用的限額。 單一預算可包含多個限制,因此多個條目可能共用一個預算 ID。

欲了解更多預算與門檻資訊,請參閱 Unity Gateway 的預算管理。

指令協助

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

命令 其功能是什麼
ug --help 顯示可用指令和一般選項。
ug configure --help 顯示工作區和代理程式設定選項。
ug mcp add --help 顯示依名稱、結構或代理程式新增 MCP 伺服器的選項。
ug skills add --help 展示下載技能或透過 MCP 連接技能的選項。