Manage channels and tracks using CLI

Last updated on October 23, 2024

Release date: March 5th, 2024

Overview

AccelByte Development Toolkit (ADT) enables you to manage your channels and tracks in ADT Hub using CLI commands. You can use these commands for automation purposes in your daily development cycle.

Manage channels

This section covers the commands you can use to manage channels in ADT Hub.

Create a new channel

Main command	Subcommand	Specific commands options and parameters
		Name	Description
channel	create	--channel	(REQUIRED) Set the name of the build channel
		--description	Insert description of the channel
		--visibility	Set the visibility between private or public. The default is public.

Return channel list

Main command	Subcommand	Specific commands options and parameters
		Name	Description
channel	list	--page UINT=0	Set the page number (starts from 0).
		--page-limit UINT=20	Set the number of items to be shown each page.

Update channel details

Main command	Subcommand	Specific commands options and parameters
		Name	Description
channel	update	--channel-id or --channel-name	(REQUIRED) Use the ID or name of the channel that you want to update.
		--name	Set the new name of the channel.
		--description	Set the new description of the channel.

Archive a channel

Main command	Subcommand	Specific commands options and parameters
		Name	Description
channel	archive	--channel-id or --channel-name	(REQUIRED) Use the ID or name of the channel.

Delete a channel

Main command	Subcommand	Specific commands options and parameters
		Name	Description
channel	delete	--channel-id or --channel-name	(REQUIRED) Use the ID or name of the channel.
		--force	If the channels have not been archived, add this parameter to the command to force the channel deletion.

Manage tracks

This section covers the commands you can use to manage tracks in ADT Hub.

Create new empty track

Main command	Subcommand	Specific commands options and parameters
		Name	Description
track	create	--channel-id or --channel-name	(REQUIRED) Use the ID or name of the channel where you want to create the track.
		--platform-name	(REQUIRED) Set the platform for the track.
		--name	(REQUIRED) Set the name of the new track.

Get head build information from a track

Main command	Subcommand	Specific commands options and parameters
		Name	Description
track	headinfo	--track-id	(REQUIRED) Use the ID of the track.

View list of tracks in a channel

Main command	Subcommand	Specific commands options and parameters
		Name	Description
track	list	--channel-id	(REQUIRED) Use the ID of the channel with the tracks list you want to view.
		--page UINT=0	Set the page number (starts from 0).
		--page-limit UINT=20	Set the number of items to be shown each page.

note

Results will display a maximum of 20 tracks by default.

Update track details

Main command	Subcommand	Specific commands options and parameters
		Name	Description
track	update	--track-id	(REQUIRED) Use the ID of the track.
		--name	Set the mew name for the track.
		--launch-arguments	Set the new launch arguments for the track.

Update the head of a track with a new build

Main command	Subcommand	Specific commands options and parameters (Name)	Specific commands options and parameters (Description)
track	update-head	--track-id	(REQUIRED) Use the ID of the track.
		--build-id or --build-name	Set the ID or name of the build that will be the new head of the track. If not specified, the value will be fetched from the game project configuration.
		--version-id or --version-name	Set the ID or name of the version that will be the new head of the track. If not specified, the value will be fetched from the game project configuration.