Référence de l’ug CLI
Utilisez la CLI Unity Gateway (ug) pour configurer et lancer des agents de code. Pour une présentation détaillée, consultez le guide de démarrage rapide sur l’agent de code.
Installer
Installez ug, puis vérifiez la version installée :
uv tool install git+https://github.com/databricks/unity-gateway
ug --version
Pour connaître les exigences, consultez les prérequis du guide de démarrage rapide.
Configurer
Commande | Fonctionnement |
|---|---|
| Connectez-vous à un Workspace Databricks et configurez vos agents à l'aide des paramètres de votre administrateur ou de la configuration guidée. |
| Configurez vos agents de manière à utiliser le workspace à l'URL spécifiée. |
| Configurez les agents listés sans invite. Pour ajouter également des serveurs MCP, ajoutez |
| Authentifiez-vous avec un jeton d'accès personnel au lieu d'OAuth. Exécutez d'abord |
Lancez un agent
Ces commandes ouvrent l'agent dans votre terminal, prêt pour votre workflow de codage habituel.
Commande | Fonctionnement |
|---|---|
| Lancez l'agent sélectionné par la configuration du Workspace publiée par votre administrateur. |
| Lancez Claude Code via Unity Gateway. |
| Launch Codex through Unity Gateway. |
| Lancez Gemini CLI par l'intermédiaire de Unity Gateway. |
| Lancez OpenCode via Unity Gateway. |
| Lancez GitHub Copilot CLI via Unity Gateway. |
| Lancez Pi via Unity Gateway. |
| Lancez Cursor Agent. Les requêtes de modèle utilisent votre compte Cursor. |
Pour Claude Code ou Codex, ajoutez --refresh pour refresh l’authentification du Workspace, les modèles et la configuration avant le lancement. Vous pouvez également transmettre des arguments spécifiques à l’agent à la commande de lancement.
Pour lancer un agent avec un modèle spécifique, par exemple dans un script, ajoutez --model avec le nom Unity Catalog complet du modèle. Cela fonctionne avec ug claude, ug codex et ug copilot:
ug claude --model <full-model-name>
Pour choisir un modèle de manière interactive après le start de l’agent, saisissez /model.
Serveurs MCP
Pour le sélecteur de serveur, les autres serveurs MCP Databricks et la configuration pour les autres clients MCP, voir Ajouter des outils et des compétences.
Commande | Fonctionnement |
|---|---|
| Sélectionnez les serveurs MCP et ajoutez leurs connexions à vos agents configurés. |
| Afficher les serveurs MCP configurés et l'état signalé par chaque agent. |
| Sélectionnez les connexions MCP à supprimer de vos agents. Les serveurs restent dans le Workspace. |
Ajouter des serveurs MCP directement
Pour ajouter des serveurs MCP sans utiliser le sélecteur, transmettez leurs noms complets Unity Catalog (<catalog>.<schema>.<server-name>) à --names:
ug mcp add --names system.ai.github,system.ai.slack
Les noms dans une commande doivent être dans le même schéma. Dans le cas contraire, ug renvoie une erreur. Pour ajouter un serveur à partir d'un autre schéma, exécutez de nouveau ug mcp add :
ug mcp add --names "<catalog>.<schema>.<server-name>"
Pour ajouter chaque serveur MCP dans un schéma :
ug mcp add --location "<catalog>.<schema>"
Par default, ug mcp add ajoute des serveurs à chacun de vos agents configurés et ne supprime pas les connexions existantes. Pour ajouter des serveurs uniquement à des agents spécifiques, ajoutez --agents:
ug mcp add --agents claude,codex --names system.ai.github
Pour configurer un agent et ajouter ses serveurs MCP en une seule commande, utilisez ug configure avec --mcp:
ug configure --agents claude --mcp system.ai.github,system.ai.slack
Redémarrez votre agent avec sa commande ug habituelle, puis exécutez ug mcp list pour vérifier les connexions.
Ajouter des serveurs MCP pour tous les développeurs (administrateurs)
Un admin de workspace peut ajouter des serveurs MCP pour chaque développeur du workspace via une configuration d'agent de codage. Pour inclure des serveurs de plus d’un schéma, listez leurs noms complets dans mcp_servers.names au niveau supérieur de la configuration :
{
"mcp_servers": {
"names": ["system.ai.github", "<catalog>.<schema>.<server-name>"]
}
}
Pour inclure chaque serveur MCP dans un schéma, définissez unity_catalog_location sur <catalog>.<schema> au lieu de names. Pour plus de détails, consultez mcp_servers.
Les développeurs exécutent ug configure pour synchroniser les serveurs avec leurs agents. Ils peuvent ajouter plus de serveurs avec ug mcp add, ce qui ignore les serveurs que la configuration du workspace fournit déjà.
Compétences
Commande | Fonctionnement |
|---|---|
| Sélectionnez les compétences publiées et download leurs fichiers dans les répertoires de compétences de l’agent local. |
| Connectez des compétences à partir de schémas Unity Catalog sélectionnés via MCP, sans download de fichiers. |
| Affichez les compétences configurées pour vos agents et la manière dont elles ont été ajoutées. |
| Sélectionnez les dossiers de compétences download à supprimer de votre ordinateur. Les compétences publiées restent inchangées. |
| Supprimez les schémas sélectionnés de la connexion MCP du registre des compétences. Les fichiers de compétences téléchargés sont conservés. |
Pour les compétences nommées, la sélection de schéma et le download de projets, voir Ajouter des outils et des compétences.
Gérez votre configuration
Commande | Fonctionnement |
|---|---|
| Afficher les limites de dépenses applicables et le pourcentage utilisé. Voir Vérifier votre utilisation. |
| Vérifiez votre installation locale ainsi que la configuration de votre agent, et proposez des corrections pour les problèmes détectés. |
| Installez la dernière version d’Unity Gateway CLI à partir de GitHub. |
| Affichez la configuration de l'agent de codage enregistrée de votre administrateur au format JSON pour pouvoir la réutiliser. |
| Restaurez les fichiers de configuration de l’agent sauvegardés et effacez l’état de configuration enregistré de |
Vérifier votre utilisation
Affichez les limites de dépenses Unity Gateway qui vous sont applicables.
Commande | Fonctionnement |
|---|---|
| Affichez jusqu'à cinq limites de dépenses applicables, classées par pourcentage d'utilisation, du plus élevé au plus bas. |
| Afficher toutes les limites de dépenses applicables dans le même ordre. |
Chaque entrée comprend un ID de budget court et l’un des libellés suivants :
Étiquette | Ce qu'il affiche |
|---|---|
Limite personnelle mensuelle | Votre utilisation par rapport au threshold par utilisateur du budget pour le mois. |
Limite partagée mensuelle | Utilisation combinée par les utilisateurs couverts par le budget par rapport à son threshold partagé pour le mois. |
Limite personnelle quotidienne | Votre utilisation par rapport au threshold par utilisateur du budget pour la journée. |
Limite quotidienne partagée | Utilisation combinée des utilisateurs couverts par le budget par rapport à son threshold partagé pour la journée. |
Vos dépenses peuvent être comptabilisées par rapport à plusieurs limites applicables. Un seul budget peut contenir plusieurs limites. Plusieurs entrées peuvent donc partager un même ID de budget.
Pour plus d'informations sur les budgets et les threshold, consultez Gérer les budgets pour Unity Gateway.
Aide sur les commandes
Utilisez --help pour afficher les options de votre version installée :
Commande | Fonctionnement |
|---|---|
| Afficher les commandes disponibles et les options générales. |
| Afficher les options de configuration du workspace et de l’agent. |
| Afficher les options permettant d'ajouter des serveurs MCP par nom, schéma ou agent. |
| Afficher les options de download de compétences ou de connexion via MCP. |