Studio 命令行接口 | 文档 - Roblox 创作者中心

Roblox Studio 支持命令行参数，让您以特殊功能启动它，例如在 Studio 启动时打开特定的地点或脚本。Roblox Studio 可执行文件通常安装在以下位置：

操作系统	位置
Windows	%localappdata%\Roblox\Versions\[version]\RobloxStudioBeta.exe
Mac	/Applications/RobloxStudio.app/Contents/MacOS/RobloxStudio

从命令行启动时，Studio 会将详细日志输出到 stdout，这些日志比输出窗口中显示的内容更详细。参数使用双破折号前缀，并且不区分大小写。包含空格的文件路径必须用引号括起来。

此处未记录的任何参数仅供内部使用，可能会在没有通知的情况下更改。

打开地点

要打开已发布的地点，请指定地点 ID、宇宙 ID 和任务。

必需参数

参数	描述
--placeId <placeId>	要打开的地点的数字 ID。
--universeId <universeId>	拥有该地点的宇宙。
--task <taskName>	指定 Studio 如何根据给定任务打开地点。有关更多信息，请参见下面的支持的任务表。

支持的任务

参数	描述
EditPlace	打开最新发布的地点版本以进行编辑。
EditPlaceRevision	打开地点的特定先前版本。需要 --placeVersion <versionNumber> 来指定版本。

可选参数

参数	描述
--targetInstanceId <guid>	在地点加载后，将 Studio 相机移动到聚焦于此 GUID 的实例。
--annotationId <guid>	在地点加载后打开此 GUID 的注释。

示例

# 打开地点的最新版本
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708

# 打开特定的先前版本
RobloxStudio.exe --task EditPlaceRevision --placeId 74265016723074 --universeId 7127583708 --placeVersion 2

打开本地文件

要打开本地地点，请使用 --task EditFile 和以下参数。

参数	描述
--localPlaceFile <path>	要打开的本地 .rbxl 或 .rbxlx 地点文件的绝对路径。

您还可以通过将文件路径作为第一个位置参数传递而不使用标志名称来打开本地地点文件。

示例

# 打开本地地点文件
RobloxStudio.exe --task EditFile --localPlaceFile "Projects\MyGame.rbxl"

# 简写
RobloxStudio.exe "Projects\MyGame.rbxl"

打开脚本

要打开脚本，请指定地点 ID、宇宙 ID 和任务，如打开地点部分所述。然后根据您希望如何打开脚本提供以下参数之一。

参数	描述
--openScriptPath <path>	脚本的路径。必须使用 / 作为分隔符，并遵循绝对 require-by-string 语义。
--openScriptFromId <uniqueId>	要打开的脚本的唯一 ID。

可选高亮

可选地，在打开脚本时高亮特定行或字符范围。

参数	描述
--startLine <n>	高亮范围的起始行。基于 1 的索引且包含。
--endLine <n>	高亮范围的结束行。基于 1 的索引且不包含。
--startCharacter <n>	行内的起始字符位置。基于 1 的索引。
--endCharacter <n>	行内的结束字符位置。基于 1 的索引且不包含。

示例

# 通过路径打开脚本
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript

# 通过 ID 打开脚本
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptFromId 604a6aa2-04cc-c820-09b3-a1dc0000537f

# 打开脚本并高亮特定行
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript --startLine 1 --endLine 5

# 打开脚本并高亮字符范围
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript --startLine 1 --endLine 1 --startCharacter 1 --endCharacter 6

运行脚本

使用 --task RunScript 在地点加载完成后执行 Luau 脚本。脚本以与 Studio 命令栏相同的权限级别运行。您可以将其与 --placeId 和 --universeId 结合使用，以在特定游戏中运行脚本，或使用 --localPlaceFile 在本地地点文件中运行脚本。如果省略这些参数，Studio 将打开默认的空基础板模板并在其中运行脚本。

必需参数

参数	描述
--runScriptFile <path>	要执行的 .lua 或 .luau 文件的绝对路径。

可选参数

参数	描述
--outputFile <path>	脚本输出写入的文件路径。
--quitAfterExecution	如果提供，脚本执行完成后 Studio 将关闭。

示例

# 在特定游戏中运行脚本并在完成后退出
RobloxStudio.exe --task RunScript --placeId 74265016723074 --universeId 7127583708 --runScriptFile smokeTest.luau --outputFile out.log --quitAfterExecution

# 在默认基础板中运行脚本
RobloxStudio.exe --task RunScript --runScriptFile smokeTest.luau

尝试资产

使用 --task TryAsset 将特定资产插入基础板模板并打开以进行编辑。

必需参数

参数	描述
--assetId <id>	要插入的资产 ID。

示例

RobloxStudio.exe --task TryAsset --assetId 53326

API 转储

使用 --api、--fullApi 或 --apiV2 将 Roblox API 表面写入文件并退出。

参数	描述
--api <path>	将 Luau 脚本 API 作为 JSON 写入指定文件。
--fullApi <path>	将完整 API 表面作为 JSON 写入指定文件。
--apiV2 <path>	将完整 API 作为 JSON 以 V2 架构格式写入指定文件。

示例

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

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

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