CLI reference

Commands that take [project] find the project by walking up from the current directory when it is left out.

rusteal new

rusteal new <Name> [--dir <path>] [--template <name>] [--variant <name>] [--feature <name>]... [--no-build] [--optimizations <on|off>]

Creates a project from a template, installs the plugins, adds each --feature as a plugin, writes the Rust workspace and runs the whole build. See Your first project, Starting from a template and Adding features.

rusteal setup <project>

Installs the Rusteal plugins into an existing project and writes a starter rusteal.toml. See Adding Rusteal to an existing project.

rusteal build [project] [--all | --from <n> | --step <n>] [--release] [--plugin <Name>]

Without flags, steps 4 and 5: build the Rust libraries and deploy them. See Building.

rusteal watch [project] [--plugin <Name>] [--optimizations <on|off>]

Writes the platform optimizations, then runs rusteal build every time a Rust source changes, until Ctrl+C. See rusteal watch.

rusteal generate [project]

Regenerates the bindings crate and the C++ wrappers from the exported reflection.

rusteal upgrade [project]

Moves the project to the CLI’s Rusteal version. See Versions and upgrades.

rusteal package [project] [--shipping] [--output <dir>] [--optimizations <on|off>]

Builds the release libraries and packages the game, with the platform optimizations unless --optimizations off. See Packaging a game.

rusteal plugin new <Name> [--template <name>] [--project <path>] [--no-build]

Creates a Rust plugin in the project. See A new plugin.

rusteal plugin package <Name> [--project <path>] [--output <dir>]

Copies a plugin out with its release library. See Packaging a plugin.

Command	What it does
`Rusteal.Reload`	Reloads every Rust library of the project.
`Rusteal.Reload <Name>`	Reloads one library: the project’s name for the game’s, the plugin’s name for a plugin’s.
`Rusteal.AutoReload 0`	Stops reloading on deploy.
`Rusteal.AutoReload 1`	Reloads on deploy (the default).