Cette page a été traduite automatiquement pour faciliter votre expérience. Nous ne pouvons pas garantir l'exactitude ou la fiabilité du contenu traduit. Si vous avez des doutes quant à la qualité de cette traduction, reportez-vous à la version anglaise de la page web.
Dans notre dernier article, nous avons examiné comment commencer avec l'Unity CLI et le package Pipeline. Si vous n'avez jamais essayé l'un ou l'autre ou si vous avez simplement besoin d'un rappel, consultez ici.
Dans cet article, nous voulions partager quelques commandes supplémentaires que vous pouvez ajouter à votre trousse à outils de développeur. Avec plus de 140 commandes, et en plus avec chaque mise à jour, vous n'avez pas besoin d'apprendre toutes. Cependant, mémoriser certaines des commandes essentielles et savoir quelles options supplémentaires sont disponibles vous permettra de mieux tirer parti des flux de travail de développeur IA. N'hésitez pas à survoler et à sélectionner ceux qui sont nouveaux et à sauter ceux que vous connaissez déjà. Plongeons-y.
Un rapide avertissement avant de plonger dans les détails : de nouvelles fonctionnalités et améliorations sont ajoutées fréquemment. Au moment de la rédaction, j'utilise la version 1.0.0-beta.10 de Unity CLI combinée à 0.6.0-exp.1 du package com.unity.pipeline et Unity 6000.6.0f1. Ainsi, les choses peuvent changer à l'avenir et si vous rencontrez des problèmes, consultez la documentation de l'Unity CLI : https://docs.unity.com/en-us/unity-cli/use-unity-cli.
1. Utilisez --help pour toute commande
Vous connaissez probablement déjà et avez utilisé la commande unity --help. Cependant, --help peut en fait être ajouté à n'importe quel niveau d'une commande imbriquée pour obtenir une documentation instantanée. En cas de doute, ajoutez simplement --help à la fin.
Voici quelques exemples :
Vous connaissez probablement déjà et avez utilisé la commande unity --help. Cependant, --help peut en fait être ajouté à n'importe quel niveau d'une commande imbriquée pour obtenir une documentation instantanée. En cas de doute, ajoutez simplement --help à la fin.
Voici quelques exemples :# Docs pour obtenir tous les éditeurs disponibles
éditeurs Unity --help
Obtenir les paramètres pour installer un module spécifique
unity install-modules --help
# Aide aux commandes d'authentification
unity auth --help
# Aide pour la commande de connexion spécifiquement
unity auth login --help
Chaque écran d'aide affichera instantanément exactement ce que fait la commande, quelles options sont disponibles et quels arguments elle attend.
Le drapeau --help est également ce que les agents utilisent pour explorer l'outil, donc lorsque vous démarrez une nouvelle session avec votre CLI, vous pouvez demander à votre agent d'exécuter --help pour vous assurer qu'il est connecté.
2. Énumérer les commandes
En parlant de documentation et de trouver votre chemin parmi les nombreuses options disponibles, il y a aussi cette commande (lorsqu'elle est exécutée sans arguments) :
commande unity
Cette commande se connecte à un Unity Editor en cours d'exécution via le serveur local du package Pipeline et vous donne une liste de chaque commande enregistrée que l'API des Éditeurs expose au shell et que l'agent peut utiliser pour travailler à l'intérieur de Unity.
Un exemple d'une façon d'utiliser des commandes pourrait être :commande unity éditeur_play
Pour faire passer l'Éditeur connecté en Mode Lecture (l'équivalent CLI de cliquer sur le bouton Lecture) afin que vos scripts commencent à s'exécuter sans que vous ayez à toucher à l'interface de l'Éditeur. De même, l'équivalent est :unity command editor_stop
Pour vous assurer que votre agent est conscient de ce que le CLI peut faire (et parce qu'il ressemble parfois à une boîte noire), un conseil que vous pouvez utiliser lorsque vous commencez un nouveau prompt est d'être plus exploratoire et de donner à Claude, Codex, etc. du contexte sur ce que le CLI peut faire. Vous pouvez faire cela en exécutant une commande comme :Exécutez "unity command" dans un bash et dites-moi ce qu'il peut faire, et testez une simple commande "eval"
3. Vérifier le statut et exécuter plusieurs instances
Si vous devez vérifier si Unity CLI est en cours d'exécution, vous pouvez simplement utiliser la commande :statut Unity
Il devrait retourner quelque chose comme ceci:Unity Editor (port 7800): readyProject: /Users/thomaskr/Github/UnityProjects/MyAwesomeProjectVersion: 6000.6.0d1PID: 85009
Si vous voyez l'état ready à côté de la première ligne, cela signifie que l'Éditeur est en direct et accessible. Il confirme également sur quel port se trouve l'Éditeur, le chemin du Projet, la Version de l'Éditeur et un identifiant de processus (PID).
unity status liste déjà tous les Éditeurs connectés, il répond donc à la question « lesquels sont en cours d'exécution ? » par lui-même. Lorsque vous devez savoir spécifiquement quels projets ont le paquet Pipeline installé et accessible, utilisez :# pipeline
liste des pipelines unity
Qui montre tous les projets Unity connus par l'interface de ligne de commande qui ont le package Pipeline en cours d'exécution, listant chaque projet avec son port de serveur et s'il est actuellement accessible.
Lorsque plusieurs éditeurs fonctionnent comme dans l'exemple ci-dessus, vous pouvez cibler un d'entre eux en passant --project-path avec son chemin de projet. Sinon, l'interface en ligne de commande choisit l'éditeur dont le projet contient le répertoire actuel.
4. Drapeaux courts et longs
La plupart des commandes offrent également un raccourci en une seule lettre conçu pour un frappe rapide dans votre flux de travail quotidien dans le terminal. Ainsi, au lieu d'exécuter unity --help, vous pouvez également utiliser unity -h, ce qui vous donne la même réponse mais vous fait économiser quelques frappes.unity --help # Version avec long flag (lisibilité améliorée)
unity -h # Version abrégée (plus rapide au quotidien)
5. Vérifiez la taille de votre projet
Si vous cherchez à libérer de l'espace, cette commande peut vous aider à identifier rapidement la taille de vos projets Unity :
Empreinte disque par dossier pour un projet, afin que vous puissiez voir combien est régénérable (Bibliothèque/Temp)
taille des projets Unity
# Résumez chaque projet enregistré, trié par taille
taille des projets Unity --all
6. Contrôler le format de sortie
Par défaut, les commandes retournent un texte lisible par l'homme, mais vous pouvez changer le format en JSON lorsqu'un script a besoin de JSON imbriqué propre pour l'analyser. Par défaut, utilisez une sortie lisible par l'homme lorsque votre agent lit un résultat petit et plat directement et n'aura pas besoin de le parser de manière programmatique, passez à --format json une fois que la réponse a une structure ou une taille qui nécessiterait autrement une supposition par regex contre un format qui n'est pas garanti de rester stable.
JSON lisible par machine
unity editors list --format json
Format convivial
liste des éditeurs Unity --format humain
7. Prévisualiser l'installation du module sans télécharger
Avant de vous engager sur le téléchargement et l'espace disque que prennent les modules volumineux, vous pouvez utiliser --dry-run, qui vous montrera exactement quels modules seraient installés et leur taille combinée, sans rien télécharger.
unity install-modules --module android ios --dry-run
Faire une simulation vous donne alors une bonne vue d'ensemble de ce à quoi ressemblera le projet complet.
8. Inspecter la configuration d'une construction avant de s'engager dans le temps de compilation
Il n'y a pas de --dry-run pour les builds, mais vous pouvez toujours valider la forme d'un avant de payer pour une compilation. unity build nécessite soit --target soit --profile, et plusieurs drapeaux sortent avant que tout build ne se produise, ce qui détecte un mauvais objectif ou un profil de build manquant en quelques secondes au lieu de minutes.
Testez votre construction avant de l'exécuter
unity build --list-targets
# Lister les profils
unity build --list-profiles
9. Installer une version spécifique de l'Éditeur avec tous les modules en une seule fois
Pour les environnements CI où la reproductibilité est importante, vous pouvez installer une version exacte de l'Éditeur sans le Hub. La version est un argument positionnel, --cm importe automatiquement les modules enfants, et les modules de plateforme nommés proviennent de la commande séparée install-modules.
# La version est positionnelle, pas un drapeau --version
unity install 6000.6.0f1
# Inclure automatiquement les modules enfants
unity install 6000.6.0f1 --cm
# Ajouter les modules de plateforme (commande séparée, supporte --dry-run)
unity install-modules --module android ios webgl
10. Processus d'installation et de mise à niveau de l'éditeur depuis le terminal
Plutôt que d'utiliser le Hub pour administrer votre processus d'installation, utilisez la commande de base unity install, qui vous donnera une liste de toutes les versions de l'Éditeur disponibles que vous pourrez ensuite installer sans ouvrir le Hub.
Guide d'installation interactif
installer Unity
Une fois que vous avez installé les nouvelles versions, vous pouvez mettre à niveau le projet en utilisant la commande `upgrade` en spécifiant le chemin du dossier de votre projet et la version à laquelle passer :# Remplacez le chemin du projet et la version de l'éditeur selon vos besoins pour votre projet
unity projects upgrade /Users/thomaskr/Github/UnityProjects/CLIDemo --to 6000.6.0f1
Dans la capture d'écran ci-dessus, vous pouvez voir comment la mise à niveau a été effectuée en une simple ligne de commande.
11. Créer un projet depuis le terminal
Vous pouvez créer de nouveaux projets via l'interface en ligne de commande avec seulement quelques commandes :
Le modèle interactif par défaut
unity projects create "CLI demo"
Exécuter le mode standard vous donne un assistant interactif qui vous guide à travers le processus. Choisissez simplement la version de l'éditeur que vous souhaitez utiliser, liez-vous à Unity Cloud et choisissez les modèles et les versions d'éditeur lors de la création, ce qui rend très facile la configuration d'un nouveau projet de la même manière que vous le feriez dans le Hub.
Cependant, contrairement au Hub, vous pouvez également automatiser vos paramètres, au cas où vous avez un flux de travail de configuration fréquent en définissant simplement les options comme vous le souhaitez. Voici un exemple où vous définissez une version d'éditeur, un modèle et un chemin de projet spécifiques.
Avec modèle (3D, 2D, VR, etc. - remplacez simplement les espaces réservés)
unity projects new "CLI demo" --editor-version 6000.6.0b9 --template com.unity.template.3d --path ~/MyProjects
12. Capturer des captures d'écran
Si vous devez capturer des captures d'écran dans vos flux de travail, vous disposez de trois commandes différentes.
# Capturer la scène ou la vue du jeu dans un fichier PNG, retourne le chemin. Params: --view, --output, --width, --height
Vue du jeu
# Note: L'interface utilisateur de superposition d'espace écran n'est PAS dans la sortie d'une caméra, elle renvoie donc du noir
capture d'écran de la commande unity --view game
Vue de scène
capture d'écran de la commande unity ---view scene
# Capturer à une résolution et une caméra spécifiques, obtenir le base64 en ligne
# Lit le backbuffer composé, donc l'interface utilisateur superposée est incluse. Mode Jeu seulement.
unity command capture_game_view --width 1920 --height 1080 --camera "Main Camera" --save_path Screenshots/check.png
Le résultat ressemblera à ceci :
Ceci peut être utile pour la boucle de vérification « implémenter ceci, prendre une capture d'écran, comparer au design » des propres directives de bonnes pratiques de Claude Code, car l'image revient sous forme de données que l'agent peut raisonner immédiatement plutôt qu'un chemin qu'il doit ensuite ouvrir séparément.
13. Journal des modifications
Parce que de nouvelles fonctionnalités sont ajoutées rapidement à l'Unity CLI et au package Pipeline, une commande pratique que j'aime utiliser est le journal des modifications que vous pouvez obtenir en exécutant simplement :
journal des modifications Unity
Il résume les changements récents en vous donnant un aperçu rapide de ce à quoi il faut faire attention et peut-être de nouveaux commandes à essayer.
14. Exécuter C# avec Eval
Lorsque le package Unity Pipeline s'exécute dans votre Éditeur, l'interface en ligne de commande peut compiler et exécuter des extraits C# en direct dans l'Éditeur en utilisant la commande eval command. Parce qu'il n'y a pas de recompilation au niveau du projet et pas de rechargement du domaine, il s'exécute en millisecondes au lieu de vous faire attendre. Vous pouvez utiliser ceci pour exécuter des scripts de configuration automatisés, interroger les états de l'éditeur ou même exécuter des fichiers de script C# depuis votre disque en utilisant unity command eval_file --file path/to/script.cs.
# Retourne vrai si l'Éditeur est actuellement en Mode Jeu
unity command eval --code "return UnityEditor.EditorApplication.isPlaying;"
# Enregistrer une simple chaîne dans la fenêtre de la console
unity command eval --code 'Debug.Log("J'ai été invoqué dans le terminal");'
15. Tests
L'outil de test de Unity, également appelé Unity Test Framework, peut être exécuté directement depuis la CLI.
Unity divise les tests en deux catégories, et la différence est très importante une fois qu'un agent les exécute de manière répétée :
- Tests du mode édition : s'exécutent instantanément, sans appuyer sur Lecture. Bon pour tester la logique pure (mathématiques, gestion des données, classes non-MonoBehaviour).
- Tests du mode de jeu : exécutez réellement votre jeu brièvement, comme le ferait un joueur. Plus lent, parce que Unity doit recharger des choses en arrière-plan.
Vous voulez probablement commencer par les tests en mode Édition. Ils sont plus rapides, plus simples à écrire et couvrent la plupart de ce dont vous avez besoin au début. Une fois que vous avez installé à la fois le Test Framework et Unity CLI, vous pouvez l'invoquer depuis la ligne de commande :
Exécuter les tests EditMode du projet
unity test --mode EditMode
Filtrer sur un sous-ensemble et écrire un rapport JUnit
unity test --mode EditMode --filter MyNamespace.MyTests --junit-output results.xml
# Exécuter uniquement les tests affectés par les changements récents
unity test --affected
Ceci s'exécute pour chaque test en mode édition. Ajoutez --junit-output results.xml et vous obtenez également un rapport structuré de ce qui a réussi et ce qui a échoué. Puis demandez à votre agent d'exécuter les tests et de résumer ce qu'il trouve, quelque chose comme : "Exécutez les tests EditMode et dites-moi uniquement ce qui échoue, en anglais simple." L'agent exécute la commande, lit le rapport et fait un rapport, plus de défilement manuel des journaux requis.
16. Gérez votre cloud
Alors que la connexion management se trouve sous unity auth, vous pouvez utiliser unity cloud pour gérer votre organisation et vos projets Unity Cloud depuis le terminal.
# Ouvre une liste de toutes les commandes cloud disponibles
Unity Cloud
Pour obtenir l'ID de votre organisation et votre compte
statut Unity Cloud
Juste l'identifiant de l'organisation active, prêt à être acheminé
org Unity Cloud actuel
17. Consulter le médecin
Lors du dépannage ou de la vérification de votre environnement, vous pouvez utiliser la commande unity doctor au lieu d'auditer manuellement l'authentification, les installations et les fichiers journaux. La commande exécute une vérification de santé complète de votre configuration, y compris les éditeurs disponibles, les configurations de proxy et les journaux d'activité récents dans une seule sortie. C'est particulièrement utile pour diagnostiquer les erreurs de configuration silencieuses sur les machines CI lors de la configuration initiale.
# Diagnostiquez votre configuration
médecin Unity
# Ajoute des traces d'erreurs complètes
unity doctor --verbose
Comme la mauvaise configuration de proxy silencieux est une cause fréquente d'échec de construction, vous pouvez envisager de vérifier l'état de l'éditeur avant d'exécuter les constructions. Vous pouvez simplement automatiser cela pour qu'il s'exécute sur les machines CI pendant la configuration.
Vous pouvez également utiliser la commande unity env. C'est un sous-ensemble de unity doctor que vous voudriez lorsque vous avez seulement besoin d'un chemin, par exemple pour vider le cache de téléchargement ou pour examiner manuellement user-settings.json.
chemins résolus (chemin d'installation, chemin de cache, chemin de configuration)
environnement Unity
18. Créer des commandes personnalisées
L'attribut [CliCommand] facilite l'écriture de commandes personnalisées pour fournir à vos agents IA des scripts personnalisés. Pour utiliser la commande CLI, vous avez juste besoin d'une méthode C# statique standard et de la décorer avec les attributs [CliCommand] et [CliArg].
Le package Pipeline découvre automatiquement ces attributs pendant la compilation, ce qui signifie qu'aucun fichier de configuration ou d'enregistrement manuel n'est nécessaire. Lorsque vous exécutez unity command sans arguments, l'interface en ligne de commande liste dynamiquement toutes les commandes personnalisées disponibles aux côtés des commandes intégrées.
Remarque : L'attribut [CliCommand] rend les commandes découvrables et invocables via l'interface de ligne de commande. Pour une exécution paramétrée, vous appelez la méthode directement en utilisant unity command eval avec la syntaxe C#, plutôt que de passer des drapeaux de style CLI.
Regardons un rapide commande personnalisée "Hello World" en action.
Créez un nouveau script C# nommé HelloWorldCommand.cs. Assurez-vous que la classe et la méthode sont statiques, et incluez l'espace de noms Unity.Pipeline.Commands> :
using UnityEngine;
using Unity.Pipeline.Commands;
public static class HelloWorldCommand
{
[CliCommand("hello-cli", "A hello world test")]
public static void SayHello()
{
Debug.Log("Bonjour à tous ! Je suis une commande CLI personnalisée.");
}
}
Pour exécuter votre nouvelle commande, lancez votre terminal et exécutez :
commande unity hello-cli
L'exécuter affiche le résultat de la commande dans votre terminal, et la sortie Debug.Log apparaît dans la fenêtre Console de l'Éditeur.
Si vous souhaitez en savoir plus sur la création de commandes personnalisées, nous y aborderons dans un article futur.
19. Utiliser le serveur MCP
Bien que l'utilisation de l'interface en ligne de commande (CLI) soit généralement le flux de travail recommandé, la CLI Unity peut également fonctionner comme un serveur MCP, si vous souhaitez une intégration d'outils native ou si votre agent a des difficultés avec les commandes shell.
MCP simplifie l'intégration en donnant aux agents un accès direct aux noms des outils, aux descriptions et aux schémas structurés sur une connexion persistante, évitant l'exécution de shell brute et l'analyse de sortie. Alors que le CLI convient aux scripts et aux flux de travail manuels, MCP intègre parfaitement les outils Unity dans les flux de travail d'IA. Les deux atteignent les mêmes capacités d'éditeur, sans différence de performance significative.
Les clients IA lancent généralement le serveur MCP automatiquement. Bien que le serveur fonctionne de manière autonome, les outils d'édition nécessitent un Éditeur actif avec le paquet Pipeline. Considérez le MCP comme une interface alternative si vos outils rencontrent des difficultés pour une raison quelconque. Dans la plupart des cas d'utilisation, Unity CLI sera la meilleure option.
Configurez votre client IA avec :
Voir quels agents sont pris en charge
unity mcp configure --list
# Ajouter le serveur à Claude Code
unity mcp configure claude-code
# Ou vers Cursor, limité au projet actuel uniquement
unity mcp configure cursor --local
Aperçu du changement de configuration sans l'écrire
unity mcp configure vscode --dry-run
20. Agent Unity pour CLI
Unity fournit une compétence d'agent pour l'interface en ligne de commande. Ceci peut aider votre agent à savoir quelles commandes existent et comment les appeler. Le CLI peut l'installer pour vous :
# Afficher les compétences disponibles sans les installer
compétence Unity
# Lister les fichiers dont est composé le savoir-faire
unity skill show --list
# Afficher les clients pris en charge et le statut d'installation
unity skill install --list
# Installez-le dans votre client IA
installer compétence unity claude-code
Mise à jour vers la dernière version
rafraîchissement de compétence Unity
Que va-t-il se passer ensuite ?
J'espère que ce fut un aperçu rapide utile des commandes. Comme mentionné, vous n'avez pas besoin de tout mémoriser, mais connaître quelques commandes de base peut être vraiment utile. Dans notre prochain article, nous examinerons de plus près le travail avec Claude Code et Unity. Bon codage de jeu !