ug CLI 参考

使用 Unity Gateway CLI (ug) 来配置和启动编码代理。 想看攻略,请看 编码代理快速入门。

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 例如, --profile DEFAULT)。 配置文件提供了工作区的 URL。

启动代理

这些命令会在你的终端中打开代理,准备进行你平时的编码工作流程。

命令 它的作用是什么
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 工作区的认证、模型和配置。 你也可以将针对 agent 的参数传递给 launch 命令。

要启动特定模型的代理,比如脚本中,添加 --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服务器

要添加没有选择器的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这样可以跳过工作区配置已经提供的服务器。

技能

命令 它的作用是什么
ug skills add 选择已发布的技能,并将其文件下载到本地代理技能目录中。
ug skills add --via mcp 通过MCP连接选定的Unity Catalog模式中的技能,无需下载文件。
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连接技能的选项。