Skip to main content

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:

ShortLongDescription
-T--templateChoose the Template to use for the project (default: place)
-l--licenseLicense to include in the project, set using SPDX identifier (requires --docs)
-g--gitInitialize a new Git repository in the project folder
-w--wallyAdd Wally manifest to use various packages in the project (if present in the template)
-d--docsInclude documentation files: README, LICENSE and CHANGELOG (if present in the template)
-t--tsInitialize 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:

ShortLongDescription
-H--hostLive sync server host name
-P--portLive sync server port
-s--sourcemapWhether to generate Sourcemap every time files change
-t--tsWhether to serve using roblox-ts
-a--asyncRun 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:

ShortLongDescription
-o--outputWhere to place built project (defaults to the current directory)
-w--watchWhether to rebuild project every time files change
-s--sourcemapWhether to generate Sourcemap every time files change
-p--pluginWhether to put built project into Roblox Studio plugins folder (ignores --output)
-x--xmlWhether to build in XML format (.rbxlx or .rbxmx)
-t--tsWhether to build using roblox-ts
-a--asyncRun 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:

ShortLongDescription
-o--outputWhere to place generated sourcemap (defaults to the current directory)
-w--watchWhether to regenerate sourcemap every time files change
-n--non-scriptsWhether non-script files should be included
-a--asyncRun 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:

ShortLongDescription
-H--hostFind the session to stop with this host name
-P--portFind the session to stop with this port
-a--allWhether to stop all running session
-l--listList all running session in a nice table

Studio

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

argon studio [path] --options

Arguments:

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

Options:

ShortLongDescription
-c--checkWhether 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, Stop), 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:

ShortLongDescription
-f--focusWhether to focus Roblox Studio window when executing code
-s--standaloneWhether to run as a separate process - launch Roblox Studio, run code and return the result
-H--hostTry to find target session by host name
-P--portTry to find target session by port

Update

Forcefully check for updates and update Argon CLI or Roblox Studio plugin if available.

argon update

Options:

ShortLongDescription
-c--cliUpdate the Argon CLI only (if available)
-p--pluginUpdate the Argon plugin only (if available)

Plugin

Install or uninstall Argon Roblox Studio plugin locally

argon plugin [mode] [path]

Arguments:

  • mode - command mode to use (install, uninstall)
  • path - path where to install or uninstall the plugin (optional)

Config

Edit Global 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:

ShortLongDescription
-l--listList all available settings and their default values in a nice table
-d--defaultRestore 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

Quick Tip!

tip

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