Interface de ligne de commande Studio | Documentation

Roblox Studio prend en charge les arguments de ligne de commande qui vous permettent de le lancer avec des fonctionnalités spéciales, telles que l'ouverture d'un lieu ou d'un script spécifique lorsque Studio démarre. L'exécutable de Roblox Studio est généralement installé aux emplacements suivants :

OS	Emplacement
Windows	%localappdata%\Roblox\Versions\[version]\RobloxStudioBeta.exe
Mac	/Applications/RobloxStudio.app/Contents/MacOS/RobloxStudio

Lorsqu'il est lancé depuis la ligne de commande, Studio envoie des journaux détaillés à stdout qui sont plus détaillés que ce qui apparaît dans la fenêtre Sortie. Les arguments utilisent un préfixe de double tiret et sont insensibles à la casse. Les chemins de fichiers contenant des espaces doivent être entre guillemets.

Tout argument non documenté ici est réservé à un usage interne et est susceptible de changer sans préavis.

Ouvrir un lieu

Pour ouvrir un lieu publié, spécifiez l'ID du lieu, l'ID de l'univers et une tâche.

Arguments requis

Argument	Description
--placeId <placeId>	L'ID numérique du lieu à ouvrir.
--universeId <universeId>	L'univers qui possède le lieu.
--task <taskName>	Spécifie comment Studio ouvre le lieu en fonction de la tâche donnée. Voir le tableau des tâches prises en charge ci-dessous pour plus d'informations.

Tâches prises en charge

Argument	Description
EditPlace	Ouvre la dernière version publiée du lieu pour l'édition.
EditPlaceRevision	Ouvre une version précédente spécifique du lieu. Nécessite --placeVersion <versionNumber> pour spécifier la version.

Arguments optionnels

Argument	Description
--targetInstanceId <guid>	Déplace la caméra de Studio pour se concentrer sur l'instance avec ce GUID après le chargement du lieu.
--annotationId <guid>	Ouvre l'annotation avec ce GUID après le chargement du lieu.

Exemples

# Ouvrir la dernière version d'un lieu
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708

# Ouvrir une version précédente spécifique
RobloxStudio.exe --task EditPlaceRevision --placeId 74265016723074 --universeId 7127583708 --placeVersion 2

Ouvrir un fichier local

Pour ouvrir un lieu local, utilisez --task EditFile avec l'argument suivant.

Argument	Description
--localPlaceFile <path>	Chemin absolu vers un fichier de lieu local .rbxl ou .rbxlx à ouvrir.

Vous pouvez également ouvrir un fichier de lieu local en passant le chemin du fichier comme le premier argument positionnel sans nom de drapeau.

Exemples

# Ouvrir un fichier de lieu local
RobloxStudio.exe --task EditFile --localPlaceFile "Projects\MyGame.rbxl"

# Abréviation
RobloxStudio.exe "Projects\MyGame.rbxl"

Ouvrir un script

Pour ouvrir un script, spécifiez l'ID du lieu, l'ID de l'univers et la tâche comme décrit dans la section ouvrir un lieu. Ensuite, fournissez l'un des arguments suivants en fonction de la manière dont vous souhaitez ouvrir le script.

Argument	Description
--openScriptPath <path>	Le chemin vers le script. Doit utiliser / comme séparateurs et suivre la sémantique require-by-string absolue.
--openScriptFromId <uniqueId>	L'ID unique du script à ouvrir.

Mise en surbrillance optionnelle

En option, mettez en surbrillance des lignes spécifiques ou une plage de caractères lors de l'ouverture du script.

Argument	Description
--startLine <n>	Ligne de départ de la plage de surbrillance. Basé sur 1 et inclusif.
--endLine <n>	Ligne de fin de la plage de surbrillance. Basé sur 1 et exclusif.
--startCharacter <n>	Position de départ du caractère dans la ligne. Basé sur 1.
--endCharacter <n>	Position de fin du caractère dans la ligne. Basé sur 1 et exclusif.

Exemples

# Ouvrir un script par chemin
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript

# Ouvrir un script par ID
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptFromId 604a6aa2-04cc-c820-09b3-a1dc0000537f

# Ouvrir un script et mettre en surbrillance des lignes spécifiques
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript --startLine 1 --endLine 5

# Ouvrir un script et mettre en surbrillance une plage de caractères
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript --startLine 1 --endLine 1 --startCharacter 1 --endCharacter 6

Exécuter un script

Utilisez --task RunScript pour exécuter un script Luau après le chargement d'un lieu. Les scripts s'exécutent au même niveau de permission que la barre de commande de Studio. Vous pouvez combiner cela avec --placeId et --universeId pour exécuter le script dans un jeu spécifique, ou --localPlaceFile pour exécuter le script dans un fichier de lieu local. Si ces arguments sont omis, Studio ouvre le modèle de baseplate vide par défaut et exécute le script là-bas.

Arguments requis

Argument	Description
--runScriptFile <path>	Chemin absolu vers un fichier .lua ou .luau à exécuter.

Arguments optionnels

Argument	Description
--outputFile <path>	Chemin vers un fichier où la sortie du script est écrite.
--quitAfterExecution	Si fourni, Studio se ferme après l'exécution du script.

Exemples

# Exécuter un script dans un jeu spécifique et quitter à la fin
RobloxStudio.exe --task RunScript --placeId 74265016723074 --universeId 7127583708 --runScriptFile smokeTest.luau --outputFile out.log --quitAfterExecution

# Exécuter un script dans la baseplate par défaut
RobloxStudio.exe --task RunScript --runScriptFile smokeTest.luau

Essayer un actif

Utilisez --task TryAsset pour insérer un actif spécifique dans un modèle de baseplate et l'ouvrir pour l'édition.

Arguments requis

Argument	Description
--assetId <id>	L'ID de l'actif à insérer.

Exemple

RobloxStudio.exe --task TryAsset --assetId 53326

Dump de l'API

Utilisez --api, --fullApi ou --apiV2 pour écrire la surface de l'API Roblox dans un fichier et quitter.

Argument	Description
--api <path>	Écrit l'API de script Luau au format JSON dans le fichier spécifié.
--fullApi <path>	Écrit la surface complète de l'API au format JSON dans le fichier spécifié.
--apiV2 <path>	Écrit l'API complète au format JSON dans le format de schéma V2 dans le fichier spécifié.

Exemples

RobloxStudio.exe --api "Desktop/output.json"

RobloxStudio.exe --fullApi "Desktop/output.json"

RobloxStudio.exe --apiV2 "Desktop/output.json"