Interface de linha de comando do Studio | Documentação

O Roblox Studio suporta argumentos de linha de comando que permitem lançá-lo com funcionalidades especiais, como abrir um lugar ou script específico quando o Studio inicia. O executável do Roblox Studio geralmente é instalado nos seguintes locais:

SO	Localização
Windows	%localappdata%\Roblox\Versions\[version]\RobloxStudioBeta.exe
Mac	/Applications/RobloxStudio.app/Contents/MacOS/RobloxStudio

Quando iniciado a partir da linha de comando, o Studio envia logs verbosos para stdout que são mais detalhados do que o que aparece na janela Output. Os argumentos usam um prefixo de duas linhas e são insensíveis a maiúsculas e minúsculas. Caminhos de arquivo que contêm espaços devem ser colocados entre aspas.

Quaisquer argumentos não documentados aqui são para uso interno apenas e estão sujeitos a alterações sem aviso prévio.

Abrir um lugar

Para abrir um lugar publicado, especifique o ID do lugar, o ID do universo e uma tarefa.

Argumentos obrigatórios

Argumento	Descrição
--placeId <placeId>	O ID numérico do lugar a ser aberto.
--universeId <universeId>	O universo que possui o lugar.
--task <taskName>	Especifica como o Studio abre o lugar com base na tarefa dada. Veja a tabela de tarefas suportadas abaixo para mais informações.

Tarefas suportadas

Argumento	Descrição
EditPlace	Abre a versão mais recente publicada do lugar para edição.
EditPlaceRevision	Abre uma versão anterior específica do lugar. Requer --placeVersion <versionNumber> para especificar a versão.

Argumentos opcionais

Argumento	Descrição
--targetInstanceId <guid>	Mova a câmera do Studio para focar na instância com este GUID após o carregamento do lugar.
--annotationId <guid>	Abre a anotação com este GUID após o carregamento do lugar.

Exemplos


# Abra a versão mais recente de um lugar
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708

# Abra uma versão anterior específica
RobloxStudio.exe --task EditPlaceRevision --placeId 74265016723074 --universeId 7127583708 --placeVersion 2

Abrir um arquivo local

Para abrir um lugar local, use --task EditFile com o seguinte argumento.

Argumento	Descrição
--localPlaceFile <path>	Caminho absoluto para um arquivo de lugar local .rbxl ou .rbxlx a ser aberto.

Você também pode abrir um arquivo de lugar local passando o caminho do arquivo como o primeiro argumento posicional sem um nome de sinalizador.

Exemplos


# Abra um arquivo de lugar local
RobloxStudio.exe --task EditFile --localPlaceFile "Projects\MyGame.rbxl"

# Atalho
RobloxStudio.exe "Projects\MyGame.rbxl"

Abrir um script

Para abrir um script, especifique o ID do lugar, o ID do universo e a tarefa, conforme descrito na seção abrir um lugar. Em seguida, forneça um dos seguintes argumentos, dependendo de como você deseja abrir o script.

Argumento	Descrição
--openScriptPath <path>	O caminho para o script. Deve usar / como separadores e seguir as semânticas absolutas de require-by-string.
--openScriptFromId <uniqueId>	O ID exclusivo do script a ser aberto.

Destacar opcionalmente

Opcionalmente, destaque linhas específicas ou um intervalo de caracteres ao abrir o script.

Argumento	Descrição
--startLine <n>	Linha inicial do intervalo de destaque. Baseada em 1 e inclusiva.
--endLine <n>	Linha final do intervalo de destaque. Baseada em 1 e exclusiva.
--startCharacter <n>	Posição inicial do caractere dentro da linha. Baseada em 1.
--endCharacter <n>	Posição final do caractere dentro da linha. Baseada em 1 e exclusiva.

Exemplos


# Abra um script pelo caminho
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript

# Abra um script pelo ID
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptFromId 604a6aa2-04cc-c820-09b3-a1dc0000537f

# Abra um script e destaque linhas específicas
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript --startLine 1 --endLine 5

# Abra um script e destaque um intervalo de caracteres
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript --startLine 1 --endLine 1 --startCharacter 1 --endCharacter 6

Executar um script

Use --task RunScript para executar um script Luau depois que um lugar termina de carregar. Os scripts são executados no mesmo nível de permissão que a barra de comando do Studio. Você pode combinar isso com --placeId e --universeId para executar o script em uma experiência específica, ou --localPlaceFile para executar o script em um arquivo de lugar local. Se esses argumentos forem omitidos, o Studio abrirá o template baseplate vazio padrão e executará o script lá.

Argumentos obrigatórios

Argumento	Descrição
--runScriptFile <path>	Caminho absoluto para um arquivo .lua ou .luau a ser executado.

Argumentos opcionais

Argumento	Descrição
--outputFile <path>	Caminho para um arquivo onde a saída do script é gravada.
--quitAfterExecution	Se fornecido, o Studio fecha após a execução do script terminar.

Exemplos


# Execute um script em uma experiência específica e saia quando terminar
RobloxStudio.exe --task RunScript --placeId 74265016723074 --universeId 7127583708 --runScriptFile smokeTest.luau --outputFile out.log --quitAfterExecution

# Execute um script no Baseplate padrão
RobloxStudio.exe --task RunScript --runScriptFile smokeTest.luau

Testar um ativo

Use --task TryAsset para inserir um ativo específico em um template de baseplate e abri-lo para edição.

Argumentos obrigatórios

Argumento	Descrição
--assetId <id>	O ID do ativo a ser inserido.

Exemplo


RobloxStudio.exe --task TryAsset --assetId 53326

Descarregar API

Use --api, --fullApi ou --apiV2 para escrever a superfície da API do Roblox em um arquivo e sair.

Argumento	Descrição
--api <path>	Escreve a API de script Luau como JSON no arquivo especificado.
--fullApi <path>	Escreve a superfície completa da API como JSON no arquivo especificado.
--apiV2 <path>	Escreve a API completa como JSON no formato do esquema V2 no arquivo especificado.

Exemplos


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

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

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