Stride CLI
Warning
申し訳ありません。このページの日本語訳はございません。英語で表示いたします。
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, visit the Manage versions section. |
stride new |
Create a project from an installed Stride version's templates. For more information, visit the Create a new project section. |
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
Create a new project
Here's an example on how to create a new project on the latest version of the engine using the CLI.
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
All Stride templates can take additional parameters to change how they are created. Here's a list of the most commonly used ones:
| Parameter | Values | Description |
|---|---|---|
-n |
text | Name of the project. |
--platform |
host (the current os), window, linux, macos, android, ios |
Platform(s) the project should target, separated by the | character. |
--HDR |
true, false |
Determines if the project uses HDR (required graphics profile >= 10.0). |
--graphics-profile |
9.0, 10.0, 11.0 |
The graphics profile to use. This can be changed later. |
--orientation |
Default, LandscapeLeft, LandscapeRight, Portrait |
The game's orientation on mobile devices. This can be changed later. |
For a list of all available parameters in a template, use the --help flag.
Example command:
stride new game -n ProjectX --HDR true --platform windows`|linux
For more detailed instructions, visit Create a project — Create a project with Stride CLI.
Manage versions
As mentioned previously, Stride CLI let's you do everything you could do with the launcher directly through the command line.
stride sdk available --prerelease # List all available versions, including betas
stride sdk install # Install the latest version
stride sdk update # Update all installed versions to the latest patch.
stride sdk uninstall 4.3 # Unintall Stride 4.3
| Command | Description |
|---|---|
stride sdk install |
Install the latest version of the engine or the resolved project's version located in the current directory. |
stride sdk install VERSION |
Install a specific version of the engine. Version patch number is optional. |
stride sdk available |
List available versions of the engine. |
stride sdk list |
List all installed versions. |
stride sdk update |
Update all installed versions of the engine to the latest patch. |
stride sdk update VERSION |
Update a specific installed version of the engine to the latest patch. Version patch number is optional. |
stride sdk uninstall VERSION |
Uninstall a specific version of the engine. |
Note
For many commands, the patch version can be skipped (e.g. 4.3).
Tip
The CLI will ignore beta versions of the engine, unless you pass the --prerelease flag.
Upgrade project to a newer version
The CLI can upgrade projects similarly to Game Studio. On top of changing the engine version, it will use additional utilities to modify assets and code, to ensure everything works properly.
stride upgrade # Upgrade the project to the latest version
stride upgrade --prerelease # Consider beta versions
stride upgrade 4.3 # Upgrade the project to 4.3
For more information visit Update Stride — Updating your project with Stride CLI.