referência da CLI ug

Use a CLI do Unity Gateway (ug) para configurar e iniciar agentes de programação. Para ver um passo a passo, consulte o início rápido de agente de programação.

Instalar

Instale ug e, em seguida, verifique a versão instalada:

Bash

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

Para obter os requisitos, consulte os pré-requisitos do início rápido.

Configurar

Comando	O que o recurso faz
ug configure	Faça login em um workspace do Databricks e configure seus agentes usando as configurações do seu administrador ou a configuração guiada.
ug configure --workspace https://your-workspace.databricks.com	Configure seus agentes para usar o workspace no URL especificado.
ug configure --profile <name> --use-pat	Autentique com um access token pessoal em vez de OAuth. Primeiro, execute databricks configure --host <workspace-url> para salvar seu token em um perfil de configuração e, em seguida, passe esse perfil com --profile (por exemplo, --profile DEFAULT). O perfil fornece a URL do workspace.

Comando	O que o recurso faz
ug configure	Faça login em um workspace do Databricks e configure seus agentes usando as configurações do seu administrador ou a configuração guiada.
ug configure --workspace https://your-workspace.databricks.com	Configure seus agentes para usar o workspace no URL especificado.
ug configure --profile <name> --use-pat	Autentique com um access token pessoal em vez de OAuth. Primeiro, execute databricks configure --host <workspace-url> para salvar seu token em um perfil de configuração e, em seguida, passe esse perfil com --profile (por exemplo, --profile DEFAULT). O perfil fornece a URL do workspace.

Lançar um agente

Esses comandos abrem o agente no seu terminal, prontos para o seu fluxo de trabalho de codificação habitual.

Comando	O que o recurso faz
ug	Inicie o agente selecionado pela configuração do workspace publicada pelo seu administrador.
ug claude	Iniciar o Claude Code por meio do Unity Gateway.
ug codex	Inicie o Codex por meio do Unity Gateway.
ug gemini	Inicie o Gemini CLI por meio do Unity Gateway.
ug opencode	Inicie o OpenCode por meio do Unity Gateway.
ug copilot	Inicie a CLI do GitHub Copilot por meio do Unity Gateway.
ug pi	Inicie o Pi por meio do Unity Gateway.
ug cursor	Iniciar o Cursor Agent. As solicitações de modelo usam sua account do Cursor.

Comando	O que o recurso faz
ug	Inicie o agente selecionado pela configuração do workspace publicada pelo seu administrador.
ug claude	Iniciar o Claude Code por meio do Unity Gateway.
ug codex	Inicie o Codex por meio do Unity Gateway.
ug gemini	Inicie o Gemini CLI por meio do Unity Gateway.
ug opencode	Inicie o OpenCode por meio do Unity Gateway.
ug copilot	Inicie a CLI do GitHub Copilot por meio do Unity Gateway.
ug pi	Inicie o Pi por meio do Unity Gateway.
ug cursor	Iniciar o Cursor Agent. As solicitações de modelo usam sua account do Cursor.

Para o Claude Code ou o Codex, adicione --refresh para dar refresh na autenticação, nos modelos e na configuração do workspace antes de iniciar. Você também pode passar argumentos específicos do agente para o comando de inicialização.

Servidores MCP

Comando	O que o recurso faz
ug mcp add	Selecione servidores MCP e adicione as conexões deles aos seus agentes configurados.
ug mcp list	Mostrar os servidores MCP configurados e o status relatado por cada agente.
ug mcp remove	Selecione as conexões MCP a serem removidas de seus agentes. Os servidores permanecem no workspace.

Comando	O que o recurso faz
ug mcp add	Selecione servidores MCP e adicione as conexões deles aos seus agentes configurados.
ug mcp list	Mostrar os servidores MCP configurados e o status relatado por cada agente.
ug mcp remove	Selecione as conexões MCP a serem removidas de seus agentes. Os servidores permanecem no workspace.

Habilidades

Comando	O que o recurso faz
ug skills add	Selecione as habilidades publicadas e faça o download dos arquivos delas nos diretórios de habilidades de agente locais.
ug skills add --via mcp	Connect skills from selected Unity Catalog schemas through MCP, without downloading files.
ug skills list	Mostrar as habilidades configuradas para seus agentes e como elas foram adicionadas.
ug skills remove	Selecione as pastas de habilidades **download** para excluir do seu computador. As habilidades publicadas permanecem inalteradas.
ug skills remove --via mcp	Remover os esquemas selecionados da conexão MCP do registro de habilidades. Os arquivos de habilidades download são mantidos.

Comando	O que o recurso faz
ug skills add	Selecione as habilidades publicadas e faça o download dos arquivos delas nos diretórios de habilidades de agente locais.
ug skills add --via mcp	Connect skills from selected Unity Catalog schemas through MCP, without downloading files.
ug skills list	Mostrar as habilidades configuradas para seus agentes e como elas foram adicionadas.
ug skills remove	Selecione as pastas de habilidades **download** para excluir do seu computador. As habilidades publicadas permanecem inalteradas.
ug skills remove --via mcp	Remover os esquemas selecionados da conexão MCP do registro de habilidades. Os arquivos de habilidades download são mantidos.

Para servidores e habilidades nomeados, seleção de esquemas e downloads de projetos, consulte Adicionar ferramentas e habilidades.

Gerencie sua configuração

Comando	O que o recurso faz
ug usage	Mostre os limites de gastos aplicáveis e a porcentagem usada. Consulte Verificar seu uso.
ug doctor	Verifique sua instalação local e a configuração do agente e ofereça correções para os problemas encontrados.
ug upgrade	Instale a versão mais recente do Unity Gateway CLI a partir do GitHub.
ug export	Exiba a configuração do agente de codificação salva do seu administrador como JSON para reutilização.
ug revert	Restaure os arquivos de configuração do agente que tiveram backup feito e limpe o estado de configuração salvo de ug.

Comando	O que o recurso faz
ug usage	Mostre os limites de gastos aplicáveis e a porcentagem usada. Consulte Verificar seu uso.
ug doctor	Verifique sua instalação local e a configuração do agente e ofereça correções para os problemas encontrados.
ug upgrade	Instale a versão mais recente do Unity Gateway CLI a partir do GitHub.
ug export	Exiba a configuração do agente de codificação salva do seu administrador como JSON para reutilização.
ug revert	Restaure os arquivos de configuração do agente que tiveram backup feito e limpe o estado de configuração salvo de ug.

Verificar o seu uso

view os limites de gastos do Unity Gateway que se aplicam a você.

Comando	O que o recurso faz
ug usage	Mostrar até cinco limites de gastos aplicáveis, ordenados pela maior para a menor porcentagem utilizada.
ug usage --all	Exibir todos os limites de gastos aplicáveis na mesma ordem.

Comando	O que o recurso faz
ug usage	Mostrar até cinco limites de gastos aplicáveis, ordenados pela maior para a menor porcentagem utilizada.
ug usage --all	Exibir todos os limites de gastos aplicáveis na mesma ordem.

Cada entrada inclui um ID de orçamento curto e um dos seguintes rótulos:

Etiqueta	O que mostra
Limite pessoal mensal	Seu uso em relação ao limite por usuário do orçamento para o mês.
Limite mensal compartilhado	Uso combinado entre usuários cobertos pelo orçamento em relação ao seu limite compartilhado para o mês.
Limite pessoal diário	Seu uso em relação ao limite por usuário do orçamento para o dia.
Limite diário compartilhado	Uso combinado de todos os usuários abrangidos pelo orçamento em relação ao seu limite compartilhado para o dia.

Etiqueta	O que mostra
Limite pessoal mensal	Seu uso em relação ao limite por usuário do orçamento para o mês.
Limite mensal compartilhado	Uso combinado entre usuários cobertos pelo orçamento em relação ao seu limite compartilhado para o mês.
Limite pessoal diário	Seu uso em relação ao limite por usuário do orçamento para o dia.
Limite diário compartilhado	Uso combinado de todos os usuários abrangidos pelo orçamento em relação ao seu limite compartilhado para o dia.

Seus gastos podem ser contabilizados em vários limites aplicáveis. Um único orçamento pode conter vários limites, por isso várias entradas podem compartilhar um ID de orçamento.

Para obter mais informações sobre orçamentos e limites, consulte Gerenciar orçamentos para o Unity Gateway.

Ajuda do comando

Use --help para ver as opções da sua versão instalada:

Comando	O que o recurso faz
ug --help	Mostrar os comandos disponíveis e as opções gerais.
ug configure --help	Mostrar opções de configuração de workspace e agente.
ug skills add --help	Mostrar opções para download de skills ou para conectá-las por meio do MCP.

Comando	O que o recurso faz
ug --help	Mostrar os comandos disponíveis e as opções gerais.
ug configure --help	Mostrar opções de configuração de workspace e agente.
ug skills add --help	Mostrar opções para download de skills ou para conectá-las por meio do MCP.