ug CLI reference

Use the Unity Gateway CLI (ug) to configure and launch coding agents. For a walkthrough, see the coding agent quickstart.

Install

Install ug, then check the installed version:

Bash

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

Requires uv and Python 3.12 or later.

Configure

Command	What it does
ug configure	Sign in to a Databricks workspace and configure your agents using your admin's settings or guided setup.
ug configure --workspace https://your-workspace.databricks.com	Configure your agents to use the workspace at the specified URL.
ug configure --profile <name> --use-pat	Authenticate with a personal access token instead of OAuth. First run databricks configure --host <workspace-url> to save your token in a configuration profile, then pass that profile with --profile (for example, --profile DEFAULT). The profile provides the workspace URL.

Command	What it does
ug configure	Sign in to a Databricks workspace and configure your agents using your admin's settings or guided setup.
ug configure --workspace https://your-workspace.databricks.com	Configure your agents to use the workspace at the specified URL.
ug configure --profile <name> --use-pat	Authenticate with a personal access token instead of OAuth. First run databricks configure --host <workspace-url> to save your token in a configuration profile, then pass that profile with --profile (for example, --profile DEFAULT). The profile provides the workspace URL.

Launch an agent

These commands open the agent in your terminal, ready for your usual coding workflow.

Command	What it does
ug	Launch the agent selected by your admin's published workspace configuration.
ug claude	Launch Claude Code through Unity Gateway.
ug codex	Launch Codex through Unity Gateway.
ug gemini	Launch Gemini CLI through Unity Gateway.
ug opencode	Launch OpenCode through Unity Gateway.
ug copilot	Launch GitHub Copilot CLI through Unity Gateway.
ug pi	Launch Pi through Unity Gateway.
ug cursor	Launch Cursor Agent. Model requests use your Cursor account.

Command	What it does
ug	Launch the agent selected by your admin's published workspace configuration.
ug claude	Launch Claude Code through Unity Gateway.
ug codex	Launch Codex through Unity Gateway.
ug gemini	Launch Gemini CLI through Unity Gateway.
ug opencode	Launch OpenCode through Unity Gateway.
ug copilot	Launch GitHub Copilot CLI through Unity Gateway.
ug pi	Launch Pi through Unity Gateway.
ug cursor	Launch Cursor Agent. Model requests use your Cursor account.

For Claude Code or Codex, add --refresh to refresh workspace authentication, models, and configuration before launching. You can also pass agent-specific arguments to the launch command.

MCP servers

Command	What it does
ug mcp add	Select MCP servers and add their connections to your configured agents.
ug mcp list	Show configured MCP servers and the status reported by each agent.
ug mcp remove	Select MCP connections to remove from your agents. The servers remain in the workspace.

Command	What it does
ug mcp add	Select MCP servers and add their connections to your configured agents.
ug mcp list	Show configured MCP servers and the status reported by each agent.
ug mcp remove	Select MCP connections to remove from your agents. The servers remain in the workspace.

Skills

Command	What it does
ug skills add	Select published skills and download their files into local agent skill directories.
ug skills add --via mcp	Connect skills from selected Unity Catalog schemas through MCP, without downloading files.
ug skills list	Show the skills configured for your agents and how they were added.
ug skills remove	Select downloaded skill folders to delete from your computer. Published skills remain unchanged.
ug skills remove --via mcp	Remove selected schemas from the skill registry's MCP connection. Downloaded skill files are kept.

Command	What it does
ug skills add	Select published skills and download their files into local agent skill directories.
ug skills add --via mcp	Connect skills from selected Unity Catalog schemas through MCP, without downloading files.
ug skills list	Show the skills configured for your agents and how they were added.
ug skills remove	Select downloaded skill folders to delete from your computer. Published skills remain unchanged.
ug skills remove --via mcp	Remove selected schemas from the skill registry's MCP connection. Downloaded skill files are kept.

For named servers and skills, schema selection, and project downloads, see Add tools and skills.

Manage your setup

Command	What it does
ug usage	Show your current spending, total budget, and percentage used.
ug doctor	Check your local installation and agent configuration, and offer fixes for problems found.
ug upgrade	Install the latest Unity Gateway CLI version from GitHub.
ug export	Print your admin's saved coding agent configuration as JSON for reuse.
ug revert	Restore backed-up agent configuration files and clear ug's saved setup state.

Command	What it does
ug usage	Show your current spending, total budget, and percentage used.
ug doctor	Check your local installation and agent configuration, and offer fixes for problems found.
ug upgrade	Install the latest Unity Gateway CLI version from GitHub.
ug export	Print your admin's saved coding agent configuration as JSON for reuse.
ug revert	Restore backed-up agent configuration files and clear ug's saved setup state.

Command help

Use --help to see the options for your installed version:

Command	What it does
ug --help	Show available commands and general options.
ug configure --help	Show workspace and agent setup options.
ug skills add --help	Show options for downloading skills or connecting them through MCP.

Command	What it does
ug --help	Show available commands and general options.
ug configure --help	Show workspace and agent setup options.
ug skills add --help	Show options for downloading skills or connecting them through MCP.