ug CLI-Referenz

Verwenden Sie die Unity Gateway CLI (ug), um Coding-Agenten zu konfigurieren und zu starten. Für eine Anleitung siehe den Quickstart des Coding-Agenten.

Installieren

Installieren ugund dann die installierte Version überprüfen:

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

Für die Anforderungen siehe die Quickstart-Voraussetzungen.

Konfigurieren

Befehl Was es bewirkt
ug configure Melden Sie sich in einem Azure Databricks Arbeitsbereich an und konfigurieren Sie Ihre Agenten mit den Einstellungen Ihres Admins oder der geleiteten Einrichtung.
ug configure --workspace https://your-workspace.databricks.com Konfigurieren Sie Ihre Agenten so, dass sie den Arbeitsbereich unter der angegebenen URL verwenden.
ug configure --agents claude,codex Konfigurieren Sie die aufgeführten Agenten ohne Aufforderung. Um auch MCP-Server hinzuzufügen, fügen Sie deren vollständige Unity-Katalognamen hinzu --mcp . Siehe Direkt MCP-Server hinzufügen.
ug configure --profile <name> --use-pat Authentifiziere dich mit einem persönlichen Zugriffstoken statt mit OAuth. Führe databricks configure --host <workspace-url> zuerst aus, um dein Token in einem Konfigurationsprofil zu speichern, und gib dann dieses Profil mit --profile (zum Beispiel --profile DEFAULT). Das Profil liefert die URL des Arbeitsbereichs.

Einen Agenten einsetzen

Diese Befehle öffnen den Agenten in deinem Terminal, bereit für deinen üblichen Codier-Workflow.

Befehl Was es bewirkt
ug Starten Sie den von der veröffentlichten Arbeitsflächenkonfiguration Ihres Administrators ausgewählten Agenten.
ug claude Claude Code über Unity Gateway starten.
ug codex Codex über Unity Gateway starten.
ug gemini Starte Gemini CLI über Unity Gateway.
ug opencode OpenCode über Unity Gateway starten.
ug copilot Starte GitHub Copilot CLI über Unity Gateway.
ug pi Starte Pi über Unity Gateway.
ug cursor Cursor-Agent starten. Modellanfragen nutzen Sie Ihr Cursor-Konto.

Für Claude Code oder Codex fügen --refresh Sie vor dem Start die Arbeitsbereichs-Authentifizierung, Modelle und Konfigurationen hinzu. Du kannst auch agentenspezifische Argumente an den Startbefehl weitergeben.

Um einen Agenten mit einem bestimmten Modell zu starten, zum Beispiel in einem Skript, fügen Sie den vollständigen Unity-Catalog-Namen des Modells hinzu.--model Dies funktioniert mit ug claude, ug codex, und ug copilot:

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

Um nach Beginn des Agenten interaktiv ein Modell auszuwählen, geben /modelSie .

MCP-Server

Für den Serverwähler, andere Azure Databricks MCP-Server und die Einrichtung für andere MCP-Clients siehe Werkzeuge und Fähigkeiten hinzufügen.

Befehl Was es bewirkt
ug mcp add Wählen Sie MCP-Server aus und fügen Sie deren Verbindungen zu Ihren konfigurierten Agenten hinzu.
ug mcp list Zeigen Sie konfigurierte MCP-Server und den von jedem Agenten gemeldeten Status.
ug mcp remove Wählen Sie MCP-Verbindungen aus, die Sie von Ihren Agenten entfernen möchten. Die Server bleiben im Arbeitsbereich.

Direkt MCP-Server hinzufügen

Um MCP-Server ohne den Picker hinzuzufügen, gib deren vollständige Unity-Katalognamen (<catalog>.<schema>.<server-name>) an --names:

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

Die Namen in einem Befehl müssen im selben Schema stehen. ug Andernfalls wird ein Fehler zurückgegeben. Um einen Server aus einem anderen Schema hinzuzufügen, führen ug mcp add Sie erneut aus:

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

Um jeden MCP-Server in einem Schema hinzuzufügen:

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

Standardmäßig ug mcp add fügt er jedem deiner konfigurierten Agenten Server hinzu und entfernt keine bestehenden Verbindungen. Um Server nur für bestimmte Agenten hinzuzufügen, fügen Sie Folgendes hinzu:--agents

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

Um einen Agenten zu konfigurieren und seine MCP-Server in einem Befehl hinzuzufügen, verwenden ug configure Sie mit --mcp:

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

Neustarte deinen Agent mit dem üblichen ug Befehl und überprüfe ug mcp list dann die Verbindungen.

Fügen Sie MCP-Server für alle Entwickler (Admins) hinzu.

Ein Workspace-Administrator kann MCP-Server für jeden Entwickler im Workspace über eine Coding-Agent-Konfiguration hinzufügen. Liste sie auf der obersten Ebene der Konfiguration auf mcp_servers.sources . Jeder Eintrag ist entweder der vollständige Name eines Servers (<catalog>.<schema>.<server-name>) oder ein ganzes Schema (<catalog>.<schema>.*), und Einträge können aus verschiedenen Schemata stammen. Zum Beispiel hält diese Konfiguration jeden Server in system.ai und fügt einen Server aus einem anderen Schema hinzu:

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

Weitere Informationen finden Sie unter mcp_servers.

Entwickler laufen ug configure , um die Server mit ihren Agenten zu synchronisieren. Sie können weitere Server mit ug mcp addhinzufügen, was Server überspringt, die bereits in der Arbeitsumgebungskonfiguration bereitgestellt werden.

Fähigkeiten

Befehl Was es bewirkt
ug skills add Wählen Sie veröffentlichte Fähigkeiten aus und laden Sie deren Dateien in lokale Agenten-Fertigkeitsverzeichnisse herunter.
ug skills add --via mcp Verbinde Skills aus ausgewählten Unity-Catalog-Schemata über MCP, ohne Dateien herunterladen zu müssen.
ug skills list Zeige die für deine Agenten konfigurierten Fähigkeiten und wie sie hinzugefügt wurden.
ug skills remove Wählen Sie heruntergeladene Fertigkeitsordner aus, die Sie von Ihrem Computer löschen möchten. Veröffentlichte Fähigkeiten bleiben unverändert.
ug skills remove --via mcp Entferne ausgewählte Schemata aus der MCP-Verbindung des Skill-Registers. Heruntergeladene Fertigkeitsdateien werden aufbewahrt.

Für benannte Fähigkeiten, Schema-Auswahl und Projektdownloads siehe Werkzeuge und Fähigkeiten hinzufügen.

Verwalten Sie Ihr Setup

Befehl Was es bewirkt
ug usage Zeigen Sie die geltenden Ausgabenlimits und den verwendeten Prozentsatz an. Siehe Check your usage.
ug doctor Überprüfen Sie Ihre lokale Installation und Agentenkonfiguration und bieten Sie Lösungen für gefundene Probleme an.
ug upgrade Installiere die neueste Unity Gateway CLI-Version von GitHub.
ug export Drucke die gespeicherte Coding-Agent-Konfiguration deines Administrators als JSON zur Wiederverwendung aus.
ug revert Wiederherstelle die gesicherten Agenten-Konfigurationsdateien und lösche ugden gespeicherten Setup-Zustand.

Überprüfe deine Nutzung

Sieh dir die Unity Gateway Ausgabelimits an, die für dich gelten.

Befehl Was es bewirkt
ug usage Zeigen Sie bis zu fünf geltende Ausgabenlimits an, geordnet von höchstem bis zum niedrigsten Prozentsatz.
ug usage --all Zeigen Sie alle geltenden Ausgabelimits in derselben Reihenfolge an.

Jeder Eintrag enthält eine kurze Budget-ID und eines der folgenden Etiketten:

Beschriftung Was es zeigt
Monatliches persönliches Limit Dein Verbrauch im Vergleich zum Budget pro Nutzer-Schwelle für den Monat.
Monatliches gemeinsames Limit Die kombinierte Nutzung der vom Budget abgedeckten Nutzer im Vergleich zu der gemeinsamen Schwelle für den Monat.
Tägliches persönliches Limit Dein Verbrauch im Vergleich zum Budget pro Nutzer-Schwelle für den Tag.
Tägliches gemeinsames Limit Kombinierte Nutzung über die vom Budget abgedeckten Nutzer gegen die gemeinsame Tagesgrenze.

Ihre Ausgaben können auf mehrere anfällige Limits angerechnet werden. Ein einzelnes Budget kann mehrere Limits enthalten, sodass mehrere Einträge eine Budget-ID teilen können.

Weitere Informationen zu Budgets und Schwellenwerten finden Sie unter Budgets und Ausgabenlimits für Unity Gateway festlegen.

Kommandohilfe

Nutze --help sie, um die Optionen für deine installierte Version zu sehen:

Befehl Was es bewirkt
ug --help Zeigen Sie verfügbare Befehle und allgemeine Optionen an.
ug configure --help Zeigen Sie Arbeitsflächen und Agenteneinrichtungsoptionen.
ug mcp add --help Zeigen Sie Optionen zum Hinzufügen von MCP-Servern nach Name, Schema oder Agent.
ug skills add --help Zeige Optionen zum Herunterladen von Fähigkeiten oder zum Verbinden über MCP.