Skip to main content

GBDX command line interface.

Project description

The gbdxcli package provides a Command Line Interface for ease of use.

Access to the GBDX API is provided without the need for programming.


The command is ‘gbdx’ and it is installed when you pip install the gbdxcli package into your virtualenv.


Note: gbdx cli uses the gbdxtools package, which requires GBDX credentials to be present in the users home dir. In order to use gbdx cli, you need GBDX credentials. Email to get these.

Help and usage information are built into the tool, use the –help switch or just throw bad commands to see it.

Note how you can walk through the command group and subcommands to get more specific help.

]$ gbdx --help
Usage: gbdx [OPTIONS] COMMAND [ARGS]...

  GBDX Command Line Interface

  example:     gbdx workflow list_tasks

  --help  Show this message and exit.

  catalog   GBDX Catalog Interface
  idaho     GBDX Idaho Interface
  ordering  GBDX Ordering Interface
  s3        GBDX S3 Interface
  s3temp    GBDX Set temporary S3 credentials
  workflow  GBDX Workflow Interface

]$ gbdx workflow --help
Usage: gbdx workflow [OPTIONS] COMMAND [ARGS]...

  GBDX Workflow Interface

  --help  Show this message and exit.

  describe_task  Show the task description json for the task...
  list_tasks     List workflow tasks available to the user
  status         Display the status information for the...

]$ gbdx workflow describe_task --help
Usage: gbdx workflow describe_task [OPTIONS]

  Show the task description json for the task named

  -n, --name TEXT  Name of task to describe
  --help           Show this message and exit.


]$ gbdx workflow list_tasks
"tasks": [
    ... lots more tasks ...

]$ gbdx workflow describe_task --name AComp
    "containerDescriptors": [
            "command": "",
            "properties": {
                "image": "tdgp/acomp:latest"
            "type": "DOCKER"
    "description": "Runs AComp code on an input 1B image.",
    "inputPortDescriptors": [
    ... more task descriptor json ...


gbdx cli is a Click application. Learn more about Click at

Installation is done via the file in the project’s home dir. Look for the entry_points clause.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for gbdxcli, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size gbdxcli-0.0.4.tar.gz (4.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page