Manage build channels using CLI
Overview
A build channel is a list of builds put together by your Build Engineer. It usually has certain properties; for example, a release build channel may only contain release builds, and a demo build channel may only contain builds that are for internal demonstration.
This guide shows you how to create and manage build channels using the build-channel command.
Create a build channel
Use the build-channel command to create a build channel.
Without inline configuration:
BlackBoxCLI.exe build-channel create --name <stream name> --as-head
With inline configuration:
BlackBoxCLI.exe build-channel create --name <stream name> --version-id xxx-xxx --build-id xxx-xxx --apikey asdf1234 --namespace myawesomegame --as-head
Modify a build channel
Use the build-channel command to modify a build channel:
Without inline configuration:
BlackBoxCLI.exe build-channel update --stream-id xxx-xxx [--as-head --name <new name>]
With inline configuration:
BlackBoxCLI.exe build-channel update --version-id xxx-xxx --build-id xxx-xxx --stream-id xxx-xxx --apikey asdf1234 --namespace myawesomegame [--as-head --name <new name>]
List existing build channels
Use the build-channel command to list the existing build channels in a namespace:
Without inline configuration:
BlackBoxCLI.exe build-channel list
With inline configuration:
BlackBoxCLI.exe build-channel list --apikey asdf1234--namespace myawesomegame
Get the build information on a build channel
Use the build-channel command to get information for the current build that becomes Head of the channel.
By build head ID
.\BlackBoxCLI.exe build-channel headinfo --id
By build head name
.\BlackBoxCLI.exe build-channel headinfo --name
The output
Format: <buildID> <buildname>, <created_datetime>
i.e
b997124b-822b-452d-930a-56de6d7a094c (0.0.1-test-pvp), 06 Jun 2022, 06:06:14
b997124b-822b-452d-930a-56de6d7a094c (a8a66237 (06 Jun 2022, 06:06:14)), 06 Jun 2022, 06:06:14
Subcommands for the build channel command
Here's the subcommand reference for the build-channel command:
| Main Command | Sub Command | Options and Parameters | |
|---|---|---|---|
| Name | Description | ||
build-channel | create | --apikey | [part of inline configuration] Set the API Key |
--namespace | [part of inline configuration] Set the namespace | ||
--game-project | [part of inline configuration] Set the directory of the game project | ||
--version-id | Set the version ID. Overrides --game-project | ||
--build-id | To set the build ID. Overrides --game-project | ||
--as-head | Set the current build ID as the head of the stream | ||
--name | Set the name of the stream | ||
build-channel | update | --apikey | [part of inline configuration] Set the API Key |
--namespace | [part of inline configuration] Set the Namespace | ||
--game-project | [part of inline configuration] Set the directory of the game project | ||
--version-id | Set the version ID. The value is from overriding the --game-project | ||
--build-id | Set the build ID. The value is from overriding the --game-project | ||
--as-head | Set the current build id as the head of the stream | ||
--name | Set the name of the stream | ||
--stream-id | Set the stream ID | ||
build-channel | list | --apikey | [part of inline configuration] Set the API Key |
--namespace | [part of inline configuration] Set the namespace | ||
--game-project | [part of inline configuration] Set the directory of the game project | ||
--version-id | Set the version id. The value is from overriding the --game-project | ||
--build-id | Set the build id. The value is from overriding the --game-project | ||