Stash CLI
Use the Stash CLI to integrate build uploads and release management into your pipelines and CI/CD workflows.
Download the latest version for Windows or macOS, or add the installation commands below to your pipeline scripts.
One-line installers
Run the following one-line installers to set up the Stash CLI:
Windows
powershell.exe -ExecutionPolicy Bypass -Command "IEX (Invoke-WebRequest 'https://cli.stash.gg/install.ps1')"MacOS
/bin/bash -c "$(curl -fsSL https://cli.stash.gg/install.sh)"After installation, run the CLI with stash-cli.
Upload builds
Use the Stash CLI to upload and configure builds. Run a separate command for each target platform.
Upload a build
stash-cli upload --env=<test|prod> \
--secret=<secret_from_stash_studio> \
--file_path=<zip_file_name> \
--executable_path="Build\my_game.exe" \
--platform=<windows|mac>
--channel=<channel_id>Parameters
The following table lists the parameters for the upload command.
| Parameter | Description | Example | Required |
|---|---|---|---|
secret | Your Stash Studio secret. Find it in Settings > API Secrets | HFeMGWYd-Tn | Yes |
file\_path | Local path to the ZIP file you want to upload | /Users/dev/builds/test.zip | Yes |
executable\_path | The path to the game executable within the zip folder | /build/test-build.exe (Windows) /build/test-build.app/Contents/MacOS/TestBuild (Mac) | Yes |
platform | The platform for the binary | windows or mac | Yes |
env | The environment to upload the binary | test or prod | No |
channel | The release channel ID. Find it in Launcher > Channels | 933e5aae-2e9-c8bd30 | No |
Was this page helpful?