Stash CLI
The Stash CLI is designed to integrate seamlessly into your build pipelines and CI/CD workflows, enabling you to automate game build uploads and release management.
You can easily add the CLI to your automated processes by downloading the latest version for Windows or macOS, or by using the installation commands below in your pipeline scripts.
One-line installers
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 completes, invoke Stash CLI using stash-cli.
Upload
The CLI currently supports uploading and configuring builds. You need to make separate calls for each platform you want to upload a build for.
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
| Parameter | Description | Example | Required |
|---|---|---|---|
secret | Your Stash Studio secret (found in Settings > API Secrets) | HFeMGWYd-Tn | Yes |
file\_path | The local path to the zip folder 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 the binary is for | windows or mac | Yes |
env | The environment to upload the binary to | test or prod | No |
channel | The release channel ID (found in Launcher > Channels) | 933e5aae-2e9-c8bd30 | No |
Was this page helpful?