wb

Categories:

Name

wb - Workbench command-line interface.

Synopsis

wb [COMMAND]

Description

The Workbench CLI allows advanced users to interact with Workbench workspaces and resources, and to perform administrative actions.

Example usage:

  • Fetch the user’s credentials and check the authentication status. wb auth login wb auth status
  • Ping the Workbench server. wb server status
  • Create a new Workbench workspace and backing Google project. Check the current context to confirm it was created successfully. wb workspace create wb status
  • List all workspaces the user has read or write access to. wb workspace list
  • To use an existing Workbench workspace, use the set command instead of create. wb workspace set --id=<workspace-id>
  • Create a Workbench-managed bucket for temporary data storage. wb resource create gcs-bucket --id=<id> --bucket-name=<name>

The Workbench CLI documentation uses Unix man page syntax. Required command parameters are denoted with (), while optional parameters are denoted with [].

Commands

  • app Manage Workbench applications.
  • auth Commands to manage user credentials.
  • bq Call BigQuery in the Workbench workspace.
  • cluster Use Spark clusters in the workspace.
  • config Commands to configure the CLI.
  • data-explorer Commands related to Data Explorer.
  • pod, crg Manage Workbench pods.
  • cromwell Commands related to Cromwell workflows.
  • folder Commands related to folder.
  • gcloud Call gcloud in the Workbench workspace.
  • generate-completion Generate bash/zsh completion script for wb.
  • git Call git in the Workbench workspace.
  • group Manage groups of Workbench users.
  • gsutil Call gsutil in the Workbench workspace.
  • nextflow Call Nextflow in the Workbench workspace.
  • notebook Use notebooks in the workspace.
  • organization, org Manage Workbench organizations.
  • resolve Resolve a resource to its cloud ID or path.
  • resource Manage references and controlled resources in the workspace.
  • security Manage Workbench security credentials such as SSH keys.
  • server Connect to a Workbench server.
  • status Print details about the current workspace and server.
  • utility Run third-party tools in the workspace.
  • version Get the installed version.
  • workflow Set up a workflow in the workspace.
  • workspace Set up a Workbench workspace.

Exit codes:

  • 0
    Successful program execution
  • 1
    User-actionable error (e.g., missing parameter, workspace not defined in the current context)
  • 2
    System or internal error (e.g., error response from the Workbench server)
  • 3
    Unexpected error (e.g., Java exception)
  • other
    Third-party application exit codes will be passed through to the caller. For example, if gcloud --malformedOption returns exit code 2, then wb gcloud --malformedOption will also return exit code 2.

Last Modified: 9 January 2026