VS Code

Learn about Argon Visual Studio Code extension commands!

Serve

Start Live Sync session of the selected project.

Arguments:

• project - project to serve

Options:

Name	Description
Generate sourcemap	Whether to generate Sourcemap every time files change
Use roblox-ts	Whether to serve using roblox-ts
Customize address	Enter a custom Live Sync server host name or port or both

Build

Build place or model project into Roblox binary or XML format.

Arguments:

• project - project to build
• output - name of the built binary or XML file (defaults to the project name)

Options:

Name	Description
Watch for changes	Whether to rebuild project every time files change
Generate sourcemap	Whether to generate Sourcemap every time files change
Build plugin	Whether to put built project into Roblox Studio plugins folder (ignores output)
Use XML format	Whether to build in XML format (.rbxlx or .rbxmx)
Use roblox-ts	Whether to build using roblox-ts

Sourcemap

Generate JSON sourcemap of the project. Very useful when using Luau LSP.

Arguments:

• project - project to generate sourcemap of
• output - name of the output file (sourcemap is recommended)

Options:

Name	Description
Watch for changes	Whether to regenerate sourcemap every time files change
Include non-scripts	Whether non-script files should be included in the sourcemap

Init

Initialize a new Argon project, read more on the Creating a New Project page.

Arguments:

• project - project name to use (default is recommended)
• template - project Template to use

Options:

Name	Description
Include docs	Include documentation files: README, LICENSE and CHANGELOG (if present in the template)
Configure Git	Initialize a new Git repository in the project folder
Setup Wally	Add Wally manifest to use various packages in the project (if present in the template)
Use roblox-ts	Initialize roblox-ts project to use TypeScript language

Stop

If there are any running Argon sessions, stop selected one or all of them.

Debug

Start or stop Roblox playtest with the selected mode.

Modes:

• Play - Play the game as a player
• Run - Run the game server only
• Start - Start game server ane players
• Stop - Stop any playtest mode

Exec

Execute Luau code in Roblox Studio, Requires running Live Sync session.

Studio

Launch a new Roblox Studio instance or open place file directly from the Visual Studio Code.

Arguments:

• place - place file (.rbxl / .rbxlx) to open (optional)

Plugin

Install or uninstall Argon Roblox Studio plugin locally.

Modes:

• Install - Install the plugin
• Uninstall - Uninstall the plugin

Update

Forcefully check for updates and update Argon components if available.

Modes:

• CLI - Update Argon CLI only
• Plugin - Update Argon Roblox Studio plugin only
• Templates - Update project templates only
• All - Update all above Argon components

Settings

Open Argon only settings in the Visual Studio Code user or workspace settings.

Help

Open Argon's documentation in the browser (homepage of this website).

info

Argon will remember your last selected options and use them by default next time.