Skip to main content

Commands

Every command also takes the global flags (--access, --secret-stdin, --url, --upload, --json). chauffeur <command> --help prints the same reference, and chauffeur gendocs --dir <folder> writes it as Markdown so it always matches your binary.

Builds and files​

chauffeur build​

Create builds from a build.yml (one build_id per platform), with release notes, and optionally upload symbols and store images.

chauffeur build --asset build.yml [flags]
FlagMeaning
--assetPath to build.yml (required)
--os, --arch, --channelReplace the file's platforms with this one (--arch defaults to x86_64)
--engine-versionEngine version, like 4.3 or 4.3.0-beta.2
--symbolsA .sym file, a folder of .sym files, or a .zip to upload for the build (needs a single platform)
chauffeur build --asset build.yml
chauffeur build --asset build.yml --os windows --arch x86_64 --symbols build/symbols
chauffeur build --asset build.yml --engine-version 4.3 --json

chauffeur addfiles​

Zip, checksum and upload one platform's files from an addfiles.yml. It adds them to the matching build, or creates the build if none matches. See Uploads for how large files are sent.

chauffeur addfiles --asset addfiles.yml [flags]
FlagMeaning
--assetPath to addfiles.yml (required)
--os, --arch, --channelOverride the file's platform
--engine-versionEngine version, used when the build is created
--symbolsSymbols to upload for the build after the files
chauffeur addfiles --asset addfiles.yml
chauffeur addfiles --asset addfiles.yml --os linux --arch arm64 --channel beta
chauffeur addfiles --asset addfiles.yml --symbols build/game.sym --json

chauffeur genbuild​

Write a starter build.yml in the current folder.

FlagMeaning
--versionBuild version (default 0.0.1, up to 32 characters)
--engine-versionEngine version
--imagesFolder of gallery images (PNG, JPEG, GIF, WebP) to add to media.gallery
chauffeur genbuild --version 1.0.0 --engine-version 4.3 --images art/screenshots

chauffeur addchangelog​

Append a changelog entry to build.yml in the current folder (up to 100 entries).

chauffeur addchangelog --title "Fixed saves" --description "Saves no longer corrupt on exit."

Both --title and --description are required.

chauffeur setfiles​

Write a starter addfiles.yml in the current folder.

FlagMeaning
--filesFolder whose files are all added
--osDefault windows
--archDefault x86_64
--channelDefault stable
--versionDefault 0.0.1
--typeBuild type (default game)
--engine-versionEngine version
--symbolsSymbols path to record in the file
chauffeur setfiles --files build/windows --os windows --arch x86_64 --version 1.0.0
chauffeur setfiles --files build/linux --os linux --symbols build/symbols

Symbols​

chauffeur symbols​

Upload Breakpad .sym files for a build so its crash reports show function names and lines. See Symbols.

chauffeur symbols --build-id <build-id> <file.sym|symbols-folder|symbols.zip>
chauffeur symbols --build-id 5f1c2d3e-0000-4000-8000-000000000000 build/game.sym
chauffeur symbols --build-id "$BLAZIUM_GAMES_BUILD_ID" build/symbols/

Store images​

All media commands act on the game that owns the deploy key. See Store images for sizes and rules.

CommandWhat it does
chauffeur media listShow the cover, thumbnail and gallery with each image's uid
chauffeur media cover <image>Replace the cover
chauffeur media thumbnail <image>Replace the thumbnail
chauffeur media add <image>... [--position N]Add 1 to 10 gallery images, appended or inserted at index N (0 is first)
chauffeur media delete <image-uid|cover|thumbnail>Delete a gallery image, or clear the cover or thumbnail
chauffeur media move <image-uid> --to NMove one gallery image to index N
chauffeur media order <image-uid>...Set the whole gallery order; list every gallery uid once
chauffeur media list --json
chauffeur media cover art/cover.png
chauffeur media add shots/*.png --position 0
chauffeur media move 5f1c2d3e-0000-4000-8000-000000000000 --to 2

Game info​

chauffeur info​

Show the game the deploy key belongs to: name, store URL, visibility, what still blocks a public listing, images, build count, channels, and the service's upload limits. Use it to check a key before a CI run.

chauffeur info
chauffeur info --json

chauffeur builds list​

List the game's builds, newest first, with their files and how many symbol files each has.

FlagMeaning
--versionOnly this version (exact match)
--os, --arch, --channelOnly this platform or channel
--pagePage number, 1 to 10,000 (default 1)
--page-sizeBuilds per page, 1 to 100 (default 20)
chauffeur builds list
chauffeur builds list --os windows --channel beta
chauffeur builds list --version 1.2.0 --json

Shell completion​

chauffeur completion bash|zsh|fish|powershell prints a completion script. For example, chauffeur completion powershell | Out-String | Invoke-Expression.

What chauffeur doesn't do​

Promoting builds between channels, rolling back, changing prices and editing store page text happen on the website or through MCP. A deploy key can't do them.