Getting Started with CLI#

The TensorBay Command Line Interface is a tool to operate on datasets. It supports Windows, Linux, and Mac platforms.

TensorBay CLI supports:

  • list, create and delete operations for dataset, segment and data.

  • uploading data to TensorBay.

  • version control operations with branch, tag, draft and commit.

  • showing commit logs of dataset on TensorBay.


To use TensorBay CLI, please install TensorBay SDK first.

$ pip3 install tensorbay


An accessKey is used for identification when using TensorBay to operate datasets.

Set the accessKey into configuration:

$ gas auth [ACCESSKEY]

To show authentication information:

$ gas auth --get


TensorBay Resource Name(TBRN) uniquely defines the resource stored in TensorBay. TBRN begins with tb:. See more details in TBRN. The following is the general format for TBRN:



CLI: Create a Dataset#

$ gas dataset tb:<dataset_name>

CLI: List Dataset Names#

$ gas dataset

CLI: Create a Draft#

$ gas draft tb:<dataset_name> [-m <title>]

CLI: List Drafts#

$ gas draft -l tb:<dataset_name>

CLI: Upload a File To the Dataset#

$ gas cp <local_path> tb:<dataset_name>#<draft_number>:<segment_name>

CLI: Commit the Draft#

$ gas commit tb:<dataset_name>#<draft_number> [-m <title>]


For users with multiple TensorBay accounts or different workspaces, CLI provides profiles to easily authenticate and use different accessKeys.

Set the accessKey into the specific profile, and show the specific profile’s authentication information:

$ gas -p <profile_name> auth [ACCESSKEY]
$ gas -p <profile_name> auth -g

After authentication, the profiles can be used to execute other commands:

$ gas -p <profile_name> <command>

For example, list all the datasets with the given profile’s accessKey:

$ gas -p <profile_name> ls

For users who want to use a temporary accessKey, CLI provides -k option to override the authentication:

$ gas -k <Accesskey> <command>

For example, list all the datasets with the given accessKey:

$ gas -k <AccessKey> ls