Stride CLI
Intermediate
The Stride CLI is a tool that allows you to work with Stride through the command line. It isn't required in order to make games, but it can be a useful utility for developers that like using a terminal.
Stride CLI features:
- Manage installed versions of the engine
- Create new projects
- Update projects
- Launch Game Studio
- Run the asset compiler
- Can be a replacement for the Stride Launcher
Warning
Even though the CLI tool can be a replacement for the launcher, it is still recommended to install it, as it also includes prerequisites for the engine.
Installing Stride CLI
The CLI tool is available for all platforms via nuget and can be installed directly through the command line.
dotnet tool install -g stride.cli
After that, you might need to open and close your terminal for the stride command to become available. You can check if it's working by running the following:
stride --version
Warning
If the command still isn't working, you might need to update your system's Path environment variable to include the directory containing dotnet tools.
Using Stride CLI
The CLI consists of many commands that provide different utilities. You can view all of them by running stride without any arguments.
stride
| Command | Description |
|---|---|
stride sdk |
Manage installed Stride versions (list, available, install, uninstall, update). For more information, read Manage versions — Managing versions with Stride CLI. |
stride new |
Create a project from an installed Stride version's templates. For more information, read Create a project — Create a project with Stride CLI. |
stride upgrade |
Upgrade a project to a newer installed Stride version. For more information, read Update Stride — Updating your project with Stride CLI. |
stride studio |
Open Game Studio. |
stride self |
Manage the Stride CLI itself. |
stride version |
Show the Stride CLI version and the resolved Stride version. |
stride legacy |
List commands kept for older (pre-4.4) Stride projects. |
stride asset |
Run the Stride Asset Compiler directly (advanced; arguments are forwarded). |
For more information about how to use a given command, use the --help flag. For example:
stride sdk --help
Example usage
stride sdk install # Install the latest version
stride new game -n ProjectX && cd ProjectX # Create a new project and enter it's directory
dotnet run --project ProjectX.Windows # Build and run the project
stride studio # Open Game Studio