Skip to content

DSH resource management API command line tool

This tool is used to call functions on the DSH resource management API from the command line of your workstation or from a script. Some of the capabilities of the dsh tool are:

  • Calling all operations exposed in the DSH resource management API from either the command line or from a script.
  • Many additional and easier to use functions are provided.
  • Extensive help information on each level using the --help and -h flags, including listings of all available operations.
  • Configuring platform and tenant credentials interactively via the dsh tool. Sensitive passwords are stored in your computer’s keychain, if available.
  • Retrieving information about the available platforms.
  • Opening web applications (e.g. the console, the swagger ui or the vhost of your app or service) from the command line.
  • Reversed lookup functions. For example find all services that use a given secret or volume, or have an environment value with a given value in their configuration.

Installation

If you don’t have the rust toolchain available (for example in a CI/CD script), you can install the pre-built versions for Linux and macOS from the project’s release page.

> cargo install dsh

This will install the dsh tool without any features.

You can add one or more features by providing the appropriate flags. For example, to install the manage and the robot features, use:

> cargo install dsh --features manage,robot

You can also use the --all-features flag to install all features.

The latest version of the tool is available here.

Are you ready to get started? Please refer to our Quick start guide.