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 --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 命令。

MCP 服务器

命令 它的作用是什么
ug mcp add 选择MCP服务器,并将其连接添加到你配置的代理中。
ug mcp list 显示已配置的MCP服务器以及每个代理报告的状态。
ug mcp remove 选择MCP连接以从代理中移除。 服务器仍留在工作区内。

技能

命令 它的作用是什么
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已保存的安装状态。

命令帮助

请使用 --help 查看您已安装版本的选项:

命令 它的作用是什么
ug --help 显示可用的命令和通用选项。
ug configure --help 显示工作区和代理设置选项。
ug skills add --help 显示下载技能或通过MCP连接技能的选项。