@ordinlabs/wsm-cli v2.4.0

Workspace Manager CLI

Getting an API Key

1. Log in to the admin application.
2. Click on your username in the top right corner and click the Profile link.
3. Click on the Profile tab.
4. Click the Generate new access key button.
5. Provide a description of the key and an expiration date.
6. Click the Generate button.
7. Copy the key and store it in a safe place. Note: there is no way to view the key after this dialog is dismissed.

Getting Started

Create a credentials file at ~/.wsm/credentials.yaml with the following settings:

url: https://www.example.com
apiKey: the-api-key

You can then use the wsm-cli command to interact with the Workspace Manager.

wsm-cli start-workspace 12345

Supported Commands

You can get the list of commands by running

wsm-cli -h

You can get help for each command by running

wsm-cli help <command>

Supporting Multiple WSM Environments

You can create multiple credentials files and use the --config option to specify which one to use.

wsm-cli --config ./dev-environment.yaml start-workspace 12345

You can also specify multiple profiles in your main ~/.wsm/credentials.yaml file.

default:
  url: https://www.example.com
  apiKey: default-api-key
dev:
  url: https://wsm-dev.example.com
  apiKey: dev-api-key

You can then specify which profile to use with the --profile option.

wsm-cli --profile dev start-workspace 12345

If no --profile option is specified, default is used.