ADT CLI Reference

Last updated on February 19, 2026

AccelByte Development Toolkit CLI

A command-line tool that supports ADT SDK usage. It helps with preparation and submission of crucial data for proper usage of ADT, including version management, build registration, symbol uploads, binary distribution, and more.

Global Options

These options can be used with any command:

Option	Description
--api-key	API key for authentication
--base-url	Base URL for the API endpoint
--cdn-url	CDN URL
--game-archive-path	Path to the game archive
--game-engine-path	Path to the game engine installation
--game-project-path	Path to the game project
--game-config-path-override	Override the game config path
--name-space	Namespace identifier
--server-archive-path	Path to the server archive
--proxy	Proxy URL for network requests
--no-log	Disable logging output
--show-version	Show CLI version information
--unity	Force Unity engine mode (by default, the CLI auto-detects the engine)

Commands

build

Manage game builds including registration, metadata, binary uploads, and status management.

build register

Register a build to the backend and store it to the Blackbox.ini file.

Option	Description
--platform-arch	Target platform architecture
--platform-name	Target platform name
--version-name	Version name to associate the build with
--version-id	Version ID to associate the build with
--branch-name	Source control branch name
--editor-build	Flag indicating this is an editor build
--smartbuild	Flag to enable smartbuild for this build
--create-new	Force creation of a new build
--disable-set-game-config	Disable automatic game config update
--enable-set-data-router	Enable Data Router configuration
--is-release-candidate	Mark build as a release candidate

build set

Check for an existing build and if found, set the Blackbox.ini file.

Option	Description
--id	Build ID to set
--version-name	Version name to look up
--version-id	Version ID to look up
--enable-set-data-router	Enable Data Router configuration

build get

Reads the Blackbox.ini file and prints the BuildId to the console.

Option	Description
--server-build-id-as-default	Use the server build ID as default

build upload-metadata

Upload metadata file(s) and associate them with the current build.

Option	Description
--type	Metadata type
--directory	Directory containing metadata files
--file	Specific metadata file to upload
--version-id	Version ID
--version-name	Version name
--build-id	Build ID
--force-parse	Force re-parsing of metadata
--force-upload	Force upload even if metadata already exists
--server-build-id-as-default	Use server build ID as default

build add-metadata

Upload key-value based metadata and associate it with the current build.

Option	Description
--key	Metadata key
--value	Metadata value
--version-id	Version ID
--version-name	Version name
--build-id	Build ID
--server-build-id-as-default	Use server build ID as default

build upload-binaries

Upload game binaries to the backend.

Option	Description
--game-archive	Path to the game archive to upload
--entry-point	Executable entry point
--build-id	Build ID to associate binaries with
--version-id	Version ID
--launch-arguments	Launch arguments for the build
--ignore-config-filepath	Config file path to ignore certain files
--log-level	Log verbosity level
--multipart-upload-size	Size of each multipart upload chunk
--show-confirmation	Show upload confirmation prompt
--server-build-id-as-default	Use server build ID as default
--force-upload	Force upload even if binaries already exist
--show-active-diagnostic	Show active diagnostic information

build set-stream

DEPRECATED - Use build-channel commands instead.

Set the current build to a stream.

Option	Description
--version-id	Version ID
--build-id	Build ID
--stream-id	Target stream ID
--server-build-id-as-default	Use server build ID as default

build find-or-register

Find an existing build or register a new one if not found.

Option	Description
--name	Build name
--platform-name	Target platform name
--platform-arch	Target platform architecture
--branch-name	Source control branch name
--smartbuild	Enable smartbuild
--editor-build	Flag indicating this is an editor build

build find-by-name

Find a build by its name.

Option	Description
--build-name	Name of the build to find
--version-id	Version ID to search within

build set-release-notes

Set the release notes for the current build.

Option	Description
--version-id	Version ID
--build-id	Build ID
--release-notes-string	Release notes as an inline string
--release-notes-path	Path to a file containing release notes
--server-build-id-as-default	Use server build ID as default

build prepare

Check the build information and prepare for operations.

Option	Description
--build-id	Build ID to prepare

build set-build-status

Set the build status of the current build.

Option	Description
--version-id	Version ID
--build-id	Build ID
--build-status	New status to set
--server-build-id-as-default	Use server build ID as default

build get-list-build-status

Get the list of all available build statuses.

No additional options.

build delete

Delete a build.

Option	Description
--version-id	Version ID
--version-name	Version name
--build-id	Build ID to delete
--server-build-id-as-default	Use server build ID as default

version

Manage game versions including creation, metadata, changelist tracking, and lifecycle management.

version add

Create a new version in the backend and store it to the Blackbox.ini file.

Option	Description
--name	Name for the new version
--disable-set-game-config	Disable automatic game config update
--enable-set-data-router	Enable Data Router configuration

version get

Reads the Blackbox.ini file and prints the VersionId to the console.

No additional options.

version set

Check for an existing version and if found, set the Blackbox.ini file.

Option	Description
--id	Version ID to set
--name	Version name to look up
--enable-set-data-router	Enable Data Router configuration

version list

List the existing versions in a game.

Option	Description
--page	Page number for paginated results
--limit	Number of results per page
--start-time	Filter by start time
--end-time	Filter by end time

version add-changelist-info

Add Perforce changelist information and associate it with the current version.

Option	Description
--author	Author of the changelist
--date-time	Date and time of the changelist
--description	Description of the changelist
--changelist-id	Perforce changelist ID

version add-changelist-bulk

Add several Perforce changelist entries in bulk from a file.

Option	Description
--file	Path to a file containing changelist information

version upload-metadata

Upload metadata file(s) and associate them with the current version.

Option	Description
--type	Metadata type
--directory	Directory containing metadata files
--file	Specific metadata file to upload
--version-id	Version ID
--version-name	Version name
--force-parse	Force re-parsing of metadata
--force-upload	Force upload even if metadata already exists

version add-metadata

Upload key-value based metadata and associate it with the current version.

Option	Description
--version-id	Version ID
--version-name	Version name
--key	Metadata key
--value	Metadata value

version delete

Delete a version.

Option	Description
--version-id	Version ID to delete
--version-name	Version name to delete

version delete-bulk

Delete versions in bulk based on a date range or version ID list.

Option	Description
--date-start	Start date for the deletion range
--date-end	End date for the deletion range
--version-ids	Comma-separated list of version IDs to delete

version enable-auto-delete

Enable automatic version deletion based on retention period.

Option	Description
--should-enable-auto-delete	Flag to enable auto-delete
--retention-period-days	Number of days to retain versions

version disable-auto-delete

Disable automatic version deletion.

Option	Description
--should-enable-auto-delete	Flag to disable auto-delete
--retention-period-days	Retention period in days

version get-auto-delete-config

Get the current automatic version deletion configuration.

No additional options.

credentials

Manage authentication credentials used by the CLI.

credentials set

Set the value of a credential entry.

Option	Description
--entry	Credential entry name (e.g., client-id, client-secret, username, password)
--value	Value to set for the credential

credentials get

Get the value of a credential entry.

Option	Description
--entry	Credential entry name to retrieve

credentials list

List all currently stored credentials.

No additional options.

config

Manage CLI configuration settings.

config set

Set the value of a configuration entry.

Option	Description
--entry	Configuration entry name
--value	Value to set
--force-recreate	Force recreation of the config file

config get

Get the value of a configuration entry.

Option	Description
--entry	Configuration entry name to retrieve
--force-recreate	Force recreation of the config file

config list

List all current configuration settings.

Option	Description
--force-recreate	Force recreation of the config file

upload

Upload PDB files, executables, and breakpad symbol files for a game. This is the primary command for submitting debug symbols.

Option	Description
--dump-path	Path to the dump files
--game-build-stamp	Game build stamp identifier
--zip-file-location	Location to save the zip file
--platform-arch	Target platform architecture
--platform-name	Target platform name (e.g., Windows, Linux, MacOS, iOS)
--temp-path	Temporary directory for processing
--upload-only	Skip parsing and upload previously processed files
--enable-profiler	Enable profiling during upload
--recursive-search	Search for symbol files recursively in subdirectories
--skip-pdb	Skip PDB file processing
--skip-engine-plugin	Skip engine plugin files
--skip-all-engine-debug-sym	Skip all engine debug symbol files
--editor-build	Indicate this is an editor build

build-channel

Manage build channels for organizing and distributing builds.

build-channel create

Create a new build channel.

Option	Description
--version-id	Version ID
--build-id	Build ID to set as head
--as-head	Set the build as the channel head
--name	Channel name
--server-build-id-as-default	Use server build ID as default
--is-empty-channel	Create an empty channel without a build

build-channel create-empty

Create an empty build channel without associating a build.

Option	Description
--version-id	Version ID
--build-id	Build ID
--as-head	Set the build as the channel head
--name	Channel name
--server-build-id-as-default	Use server build ID as default
--is-empty-channel	Mark as empty channel

build-channel update

Update an existing build channel.

Option	Description
--version-id	Version ID
--build-id	Build ID to set as new head
--as-head	Update the channel head
--build-channel-id	Build channel ID to update
--name	New channel name
--server-build-id-as-default	Use server build ID as default

build-channel list

List all build channels in a namespace.

Option	Description
--version-id	Filter by version ID
--build-id	Filter by build ID
--page	Page number for pagination
--page-limit	Number of results per page

build-channel head-info

Get the head information of a build channel.

Option	Description
--build-channel-id	Build channel ID
--build-channel-name	Build channel name

stream

Manage streams for build distribution. Streams are similar to build channels and provide a way to organize builds.

stream create

Create a new stream.

Option	Description
--version-id	Version ID
--build-id	Build ID to associate
--as-head	Set the build as the stream head
--name	Stream name
--server-build-id-as-default	Use server build ID as default
--is-empty-channel	Create an empty stream

stream update

Update an existing stream.

Option	Description
--version-id	Version ID
--build-id	Build ID to set as new head
--as-head	Update the stream head
--build-channel-id	Stream/channel ID to update
--name	New stream name
--server-build-id-as-default	Use server build ID as default

stream list

List all available streams in the namespace.

Option	Description
--version-id	Filter by version ID
--build-id	Filter by build ID
--page	Page number for pagination
--page-limit	Number of results per page

game-binary

Upload and download game binary archives.

game-binary upload

Upload game binaries to the backend.

Option	Description
--client-id	OAuth client ID
--client-secret	OAuth client secret
--username	Username for authentication
--password	Password for authentication
--game-id	Game ID
--version-id	Version ID
--build-id	Build ID
--bearer-file	Path to a file containing the bearer token
--game-archive	Path to the game archive to upload
--entry-point	Executable entry point
--launch-arguments	Launch arguments
--ignore-config-filepath	Config file path for ignore rules
--log-level	Log verbosity level
--multipart-upload-size	Size of each multipart upload chunk
--show-confirmation	Show upload confirmation prompt
--server-build-id-as-default	Use server build ID as default
--force-upload	Force upload even if binaries already exist
--show-active-diagnostic	Show active diagnostic information

game-binary upload-with-bearer

Upload game binaries using a pre-obtained bearer token (same options as upload).

game-binary download

Download game binaries from the backend.

Option	Description
--client-id	OAuth client ID
--client-secret	OAuth client secret
--username	Username for authentication
--password	Password for authentication
--build-id	Build ID to download
--download-dir	Directory to save downloaded files
--show-confirmation	Show download confirmation prompt
--log-level	Log verbosity level
--local-cache-url	Local cache URL for faster downloads
--server-build-id-as-default	Use server build ID as default

debug-symbol

Parse and process debug symbol files.

debug-symbol parse

Parse a PDB file and dump the information into a JSON file.

Option	Description
--symbol-folder	Folder containing symbol files
--save-folder	Folder to save parsed output
--platform-name	Target platform name

session

Manage session-related data uploads.

session upload-metadata

Upload session metadata files.

Option	Description
--bearer-token	Bearer token for authentication
--directory	Directory containing metadata files
--file	Specific metadata file to upload
--game-id	Game ID
--version-id	Version ID
--build-id	Build ID
--session-id	Session ID to associate metadata with
--maximum-part-size	Maximum part size for multipart uploads
--batch-size	Number of files to upload in each batch
--operation-id	Operation ID for tracking
--show-active-diagnostic	Show active diagnostic information

diagnostic

Create diagnostic packages for troubleshooting CLI operations.

diagnostic package

Create a diagnostic package from operation logs.

Option	Description
--operation-ids	One or more operation IDs to include (can be specified multiple times)
--target-path	Path to save the diagnostic package

launch-arguments

Manage launch arguments associated with builds.

launch-arguments update

Update launch arguments for a build.

Option	Description
--version-id	Version ID
--version-name	Version name
--build-id	Build ID
--build-name	Build name
--launch-arguments	New launch arguments string

launch-arguments delete

Delete launch arguments from a build.

Option	Description
--version-id	Version ID
--version-name	Version name
--build-id	Build ID
--build-name	Build name

launch-arguments read

Read the current launch arguments for a build.

Option	Description
--version-id	Version ID
--version-name	Version name
--build-id	Build ID
--build-name	Build name

smartbuild

Manage smartbuild uploads, downloads, staging, and caching. Smartbuild provides efficient incremental build distribution.

smartbuild upload

Upload a smartbuild to the backend.

Option	Description
--access-token	Access token for authentication
--client-id	OAuth client ID
--client-secret	OAuth client secret
--username	Username for authentication
--password	Password for authentication
--game-id	Game ID
--version-id	Version ID
--version-name	Version name
--build-id	Build ID
--upload-dir	Directory containing files to upload
--entry-point	Executable entry point
--launch-argument	Launch arguments
--encryption-key	Encryption key for the build
--multipart-size-mb	Multipart upload chunk size in MB
--temp-path	Temporary directory for processing
--ignore-config-path	Config file path for ignore rules
--project-dir	Project directory
--cache-dir	Cache directory
--operation-id	Operation ID for tracking
--log-severity	Log severity level
--show-active-diagnostic	Show active diagnostic information
--force-upload	Force upload even if build already exists
--skip-extraction	Skip extraction step
--disable-progress-log	Disable progress log output
--priority	Upload priority level

smartbuild download

Download a smartbuild from the backend.

Option	Description
--access-token	Access token for authentication
--game-id	Game ID
--build-id	Build ID to download
--cache-dir	Local cache directory
--block-mb-size	Block size in MB for download chunks
--operation-id	Operation ID for tracking
--local-cache-url	Local cache URL for faster downloads
--log-severity	Log severity level
--show-active-diagnostic	Show active diagnostic information
--disable-progress-log	Disable progress log output
--priority	Download priority level

smartbuild download-info

Get smartbuild download information without downloading (same options as download).

smartbuild show-version

Show the smartbuild library version.

No additional options.

smartbuild stage install

Install a smartbuild to a staging directory.

Option	Description
--access-token	Access token for authentication
--game-ns	Game namespace
--game-id	Game ID
--build-id	Build ID to install
--stage-dir	Staging directory path
--cache-dir	Cache directory
--temp-path	Temporary directory
--operation-id	Operation ID for tracking
--log-severity	Log severity level
--should-clean	Clean the staging directory before install
--show-active-diagnostic	Show active diagnostic information
--disable-progress-log	Disable progress log output
--priority	Install priority level

smartbuild stage uninstall

Uninstall a smartbuild from a staging directory.

Option	Description
--stage-dir	Staging directory to uninstall from
--operation-id	Operation ID for tracking
--log-severity	Log severity level
--show-active-diagnostic	Show active diagnostic information
--disable-progress-log	Disable progress log output

smartbuild stage verify

Verify the integrity of a staged smartbuild.

Option	Description
--access-token	Access token for authentication
--game-id	Game ID
--build-id	Build ID to verify
--stage-dir	Staging directory to verify
--cache-dir	Cache directory
--operation-id	Operation ID for tracking
--log-severity	Log severity level
--show-active-diagnostic	Show active diagnostic information
--disable-progress-log	Disable progress log output

smartbuild stage repair

Repair a damaged staged smartbuild by re-downloading corrupted blocks.

Option	Description
--access-token	Access token for authentication
--game-id	Game ID
--build-id	Build ID to repair
--stage-dir	Staging directory to repair
--cache-dir	Cache directory
--block-mb-size	Block size in MB for download chunks
--operation-id	Operation ID for tracking
--log-severity	Log severity level
--show-active-diagnostic	Show active diagnostic information
--disable-progress-log	Disable progress log output

smartbuild cache purge

Purge the smartbuild cache to free disk space.

Option	Description
--cache-dir	Cache directory to purge
--operation-id	Operation ID for tracking
--log-severity	Log severity level
--cache-size-limit-bytes	Maximum cache size in bytes to retain
--show-active-diagnostic	Show active diagnostic information
--disable-progress-log	Disable progress log output

track

Manage tracks for build distribution and versioning.

track update

Update a track's head to point to a specific build.

track update-build

Update a track with build information.

track list

List all available tracks.

track head-info

Get the head information of a track.

ps5

Manage PS5-specific configuration. (Available in UE4 builds only)

ps5 update-url

Update the PS5 upload URL.

Option	Description
--url	New PS5 upload URL

ps5 get-url

Get the currently configured PS5 upload URL.

No additional options.

sdk

Manage SDK integration with game projects. (Available in UE4 builds only)

sdk install

Automatically integrate the ADT SDK into a game project.

Option	Description
--sdk-path	Path to the SDK to install

sdk remove

Remove the ADT SDK from a game project.

No additional options.

crash-url

Manage crash reporting URL configuration in the game engine.

crash-url get

Get the current crash URL from the engine configuration.

No additional options.

crash-url set

Set the engine crash URL to the ADT URL for crash report collection.

No additional options.

Engine Support

The CLI supports two game engine implementations:

• Unreal Engine 4 (UE4) - Full feature support including PS5 and SDK commands
• Unity - Core feature support; use the --unity global flag to force Unity mode

The engine is auto-detected based on the project path. Use --unity to override detection.

Configuration Files

File	Description
Blackbox.ini	Stores current version ID, build ID, and other session data
config.ini	Stores CLI configuration settings
Credentials store	Stores authentication credentials (client ID, secret, username, password)

Authentication

The CLI supports multiple authentication methods:

1. Credentials command - Store credentials persistently using credentials set
2. Inline options - Pass --client-id, --client-secret, --username, --password directly
3. API key - Use --api-key for API key-based authentication
4. Bearer token - Use --bearer-file or --bearer-token for token-based authentication
5. Access token - Use --access-token for smartbuild commands