CLI

Learn about Agon command line interface commands!

Init

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

argon init [project] --options

Arguments:

• project - path to the new project or its parent folder (optional)

Options:

Short	Long	Description
-T	--template	Choose the Template to use for the project (default: place)
-l	--license	License to include in the project, set using SPDX identifier (requires --docs)
-g	--git	Initialize a new Git repository in the project folder
-w	--wally	Add Wally manifest to use various packages in the project (if present in the template)
-d	--docs	Include documentation files: README, LICENSE and CHANGELOG (if present in the template)
-t	--ts	Initialize roblox-ts project to use TypeScript language

Serve

Start Live Sync session of the current or selected project.

argon serve [project] [session] --options

Arguments:

• project - path to the project to serve (optional)
• session - name of the session to start (optional)

Options:

Short	Long	Description
-H	--host	Live sync server host name
-P	--port	Live sync server port
-s	--sourcemap	Whether to generate Sourcemap every time files change
-t	--ts	Whether to serve using roblox-ts
-a	--async	Run Argon asynchronously, freeing up the terminal

Build

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

argon build [project] [session] --options

Arguments:

• project - path to the project to build (optional)
• session - name of the session to start (optional)

Options:

Short	Long	Description
-o	--output	Where to place built project (defaults to the current directory)
-w	--watch	Whether to rebuild project every time files change
-s	--sourcemap	Whether to generate Sourcemap every time files change
-p	--plugin	Whether to put built project into Roblox Studio plugins folder (ignores --output)
-x	--xml	Whether to build in XML format (.rbxlx or .rbxmx)
-t	--ts	Whether to build using roblox-ts
-a	--async	Run Argon asynchronously, freeing up the terminal (requires --watch)

Sourcemap

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

argon sourcemap [project] [session] --options

Arguments:

• project - path to the project to serve (optional)
• session - name of the session to start (optional)

Options:

Short	Long	Description
-o	--output	Where to place generated sourcemap (defaults to the current directory)
-w	--watch	Whether to regenerate sourcemap every time files change
-n	--non-scripts	Whether non-script files should be included
-a	--async	Run Argon asynchronously, freeing up the terminal (requires --watch)

Stop

Stop Argon session by address, ID or all running sessions. This command is useful when run_async setting is enabled. If left empty, the last session will be stopped.

argon stop [session] --options

Arguments:

• session - name of the session to stop (optional)

Options:

Short	Long	Description
-H	--host	Find the session to stop with this host name
-P	--port	Find the session to stop with this port
-a	--all	Whether to stop all running session
-l	--list	List all running session in a nice table

Studio

Launch a new Roblox Studio instance or open place file directly from the command line.

argon studio [path] --options

Arguments:

• path - path to the place file to open (optional)

Options:

Short	Long	Description
-c	--check	Whether to check if Roblox Studio is already running, if so Roblox Studio won't be launched

Debug

Start or stop Roblox playtest with the selected mode.

argon debug [mode]

Arguments:

• mode - debug mode to use - play, run, start or stop (optional, defaults to play)

Exec

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

argon exec [code] [session] --options

Arguments:

• code - Luau code to execute, or path to the file with code
• session - name of the session to send code execution request to (optional, defaults to the last session)

Options:

Short	Long	Description
-f	--focus	Whether to focus Roblox Studio window when executing code
-s	--standalone	Whether to run as a separate process - launch Roblox Studio, run code and return the result
-H	--host	Try to find target session by host name
-P	--port	Try to find target session by port

Update

Manually check for updates and update Argon components if available.

argon update [mode] --options

Arguments:

• mode - whether to update cli, plugin, templates or all (optional, defaults to all)

Options:

Short	Long	Description
-f	--force	Whether to force update even if there is no newer version available

Plugin

Install or uninstall Argon Roblox Studio plugin locally

argon plugin [mode] [path]

Arguments:

• mode - whether to install or uninstall the plugin (optional, defaults to install)
• path - path where to install or uninstall the plugin (optional)

Config

Edit Global or Workspace configuration directory from the command line or using the default editor.

argon config [setting] [value] --options

Arguments:

• setting - name of the setting to edit (optional)
• value - new value for the setting (optional)

Options:

Short	Long	Description
-l	--list	List all available settings and their default values in a nice table
-d	--default	Restore all settings to their default values

Doc

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

argon doc

Help

Print help message that shows all available commands and options with their descriptions.

argon help

tip

Almost all command options can be saved in the Global Configuration file to use them by default next time.