Fixing README; documenting Env Variables to configure

Author: dishantlangayan

README.md

@@ -12,6 +12,7 @@ The Solace Cloud CLI
 
 <!-- toc -->
 * [Usage](#usage)
+* [Configuration](#configuration)
 * [Commands](#commands)
 <!-- tocstop -->
 # Usage
@@ -28,9 +29,32 @@ USAGE
 ...
 ```
 <!-- usagestop -->
+# Configuration
+<!-- configuration -->
+To use any commands you will need to configure an Access Token in Solace Cloud Console with the appropriate permissions first. The access token can be set using the follow Environment Variable:
+
+```
+SC_ACCESS_TOKEN=<Your access token>
+```
+
+The following Environment variables are optional:
+
+* SC_API_VERSION  - The API version of the Solace Cloud REST API. Default is `v2`.
+* SC_BASE_URL     - The location of your Solace Home Cloud account determines the base URL you use. Default is `https://api.solace.cloud/`
+
+<!-- configurationtop -->
 # Commands
 <!-- commands -->
 * [`sc help [COMMAND]`](#sc-help-command)
+* [`sc missionctrl broker create`](#sc-missionctrl-broker-create)
+* [`sc missionctrl broker delete`](#sc-missionctrl-broker-delete)
+* [`sc missionctrl broker display`](#sc-missionctrl-broker-display)
+* [`sc missionctrl broker list`](#sc-missionctrl-broker-list)
+* [`sc platform env create`](#sc-platform-env-create)
+* [`sc platform env delete`](#sc-platform-env-delete)
+* [`sc platform env display`](#sc-platform-env-display)
+* [`sc platform env list`](#sc-platform-env-list)
+* [`sc platform env update`](#sc-platform-env-update)
 * [`sc plugins`](#sc-plugins)
 * [`sc plugins add PLUGIN`](#sc-plugins-add-plugin)
 * [`sc plugins:inspect PLUGIN...`](#sc-pluginsinspect-plugin)
@@ -62,6 +86,292 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.29/src/commands/help.ts)_
 
+## `sc missionctrl broker create`
+
+Create an event broker service. You must provide a unique name and select a service class and datacenter. You can optionally define other properties for the event broker service.
+
+```
+USAGE
+  $ sc missionctrl broker create -d <value> -n <value> -c <value> [-e <value>] [-l] [-s <value>] [-m <value>] [-r] [-v
+  <value>]
+
+FLAGS
+  -c, --service-class-id=<value>
+      (required) Supported service classes.
+
+  -d, --datacenter-id=<value>
+      (required) The identifier of the datacenter.
+
+  -e, --env-name=<value>
+      The name of the environment environment where you want to create the service.
+      You can only specify an environment identifier when creating services in a Public Region.
+      You cannot specify an environment identifier when creating a service in a Dedicated Region.
+      If no name is provided, the service will be created in the default environment.
+
+  -l, --locked
+      Indicates if you can delete the event broker service after creating it. The default value is false.
+
+  -m, --msg-vpn-name=<value>
+      The message VPN name. A default message VPN name is provided when this is not specified.
+
+  -n, --name=<value>
+      (required) Name of the event broker service to create.
+
+  -r, --redundancy-group-ssl-enabled
+      Enable or disable SSL for the redundancy group (for mate-link encryption). The default value is false (disabled)
+
+  -s, --max-spool-usage=<value>
+      The message spool size, in gigabytes (GB). A default message spool size is provided if this is not specified.
+
+  -v, --version=<value>
+      The event broker version. A default version is provided when this is not specified.
+
+DESCRIPTION
+  Create an event broker service. You must provide a unique name and select a service class and datacenter. You can
+  optionally define other properties for the event broker service.
+
+  Your token must have one of the permissions listed in the Token Permissions.
+
+  Token Permissions: [ `services:post` ]
+
+EXAMPLES
+  $ sc missionctrl broker create --name=MyBrokerName --datacenter-id=eks-ca-central-1a --service-class-id=DEVELOPER
+```
+
+_See code: [src/commands/missionctrl/broker/create.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.1/src/commands/missionctrl/broker/create.ts)_
+
+## `sc missionctrl broker delete`
+
+Delete a service using its unique identifier.
+
+```
+USAGE
+  $ sc missionctrl broker delete [-b <value>] [-n <value>]
+
+FLAGS
+  -b, --broker-id=<value>  Id of the event broker service.
+  -n, --name=<value>       Name of the event broker service.
+
+DESCRIPTION
+  Delete a service using its unique identifier.
+
+  Your token must have one of the permissions listed in the Token Permissions.
+
+  Token Permissions: [ `services:delete` **or** `services:delete:self` **or** `mission_control:access` ]
+
+EXAMPLES
+  $ sc missionctrl broker delete --broker-id=MyBrokerId
+
+  $ sc missionctrl broker delete --name=MyBrokerName
+```
+
+_See code: [src/commands/missionctrl/broker/delete.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.1/src/commands/missionctrl/broker/delete.ts)_
+
+## `sc missionctrl broker display`
+
+Get the details of an event broker service using its identifier or name.
+
+```
+USAGE
+  $ sc missionctrl broker display [-b <value>] [-n <value>]
+
+FLAGS
+  -b, --broker-id=<value>  Id of the event broker service.
+  -n, --name=<value>       Name of the event broker service.
+
+DESCRIPTION
+  Get the details of an event broker service using its identifier or name.
+
+  Use either the Event Broker's ID (--broker-id) or name of the Event Broker (--name).
+
+  Token Permissions: [ `mission_control:access` **or** `services:get` **or** `services:get:self` **or** `services:view`
+  **or** `services:view:self` ]
+
+EXAMPLES
+  $ sc missionctrl broker display
+```
+
+_See code: [src/commands/missionctrl/broker/display.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.1/src/commands/missionctrl/broker/display.ts)_
+
+## `sc missionctrl broker list`
+
+Get a listing of event broker services.
+
+```
+USAGE
+  $ sc missionctrl broker list [-n <value>] [--pageNumber <value>] [--pageSize <value>] [--sort <value>]
+
+FLAGS
+  -n, --name=<value>
+      Name of the event broker service to match on.
+
+  --pageNumber=<value>
+      The page number to get. Defaults to 1
+
+  --pageSize=<value>
+      The number of event broker services to return per page. Defaults to 100
+
+  --sort=<value>
+      Sort the returned event broker services by attribute.
+
+      You can use the following value formats for the sort order:
+
+      * attributes-names
+      * attributes-names:sort-order
+
+DESCRIPTION
+  Get a listing of event broker services.
+
+  Your token must have one of the permissions listed in the Token Permissions.
+
+  Token Permissions: [ `mission_control:access` **or** `services:get` **or** `services:get:self` **or** `services:view`
+  **or** `services:view:self` ]
+
+EXAMPLES
+  $ sc missionctrl broker list --name=MyBrokerName --pageNumber=1 --pageSize=10 --sort=name:asc
+```
+
+_See code: [src/commands/missionctrl/broker/list.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.1/src/commands/missionctrl/broker/list.ts)_
+
+## `sc platform env create`
+
+Create a new environment.
+
+```
+USAGE
+  $ sc platform env create -n <value> [-d <value>] [--isDefault] [--isProduction]
+
+FLAGS
+  -d, --desc=<value>  Description of the environment to create.
+  -n, --name=<value>  (required) Name of the environment to create.
+      --isDefault     Indicates this is the organization’s default environment.
+      --isProduction  Indicates this is an organization’s production environment.
+                      This is an immutable field. If an environment needs to be migrated,
+                      architecture can be migrated to a new environment with the desired
+                      environment type instead.
+
+DESCRIPTION
+  Create a new environment.
+
+  Token Permissions: [ environments:edit ]
+
+EXAMPLES
+  $ sc platform env create --name=MyEnvironment --desc="My environment description" --isDefault --isProduction
+```
+
+_See code: [src/commands/platform/env/create.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.1/src/commands/platform/env/create.ts)_
+
+## `sc platform env delete`
+
+Delete an environment using either its name or unique identifier. The default environment cannot be deleted.
+
+```
+USAGE
+  $ sc platform env delete [-e <value>] [-n <value>]
+
+FLAGS
+  -e, --env-id=<value>  Id of the environment.
+  -n, --name=<value>    Name of the environment.
+
+DESCRIPTION
+  Delete an environment using either its name or unique identifier. The default environment cannot be deleted.
+
+  Token Permissions: [ environments:edit ]
+
+EXAMPLES
+  $ sc platform env delete --name=MyEnvName
+
+  $ sc platform env delete --env-id=MyEnvId
+```
+
+_See code: [src/commands/platform/env/delete.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.1/src/commands/platform/env/delete.ts)_
+
+## `sc platform env display`
+
+Display information about an Environment.
+
+```
+USAGE
+  $ sc platform env display [-e <value>] [-n <value>]
+
+FLAGS
+  -e, --env-id=<value>  Id of the environment.
+  -n, --name=<value>    Name of the environment.
+
+DESCRIPTION
+  Display information about an Environment.
+
+  Use either the Environment's ID (--env-id) or name of the Environment (--name).
+
+  Required token permissions: [ environments:view ]
+
+
+EXAMPLES
+  $ sc platform env display --name=MyEnvName
+
+  $ sc platform env display --env-id=MyEnvId
+```
+
+_See code: [src/commands/platform/env/display.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.1/src/commands/platform/env/display.ts)_
+
+## `sc platform env list`
+
+Get a list of all Environments. 
+
+```
+USAGE
+  $ sc platform env list [-n <value>] [--pageNumber <value>] [--pageSize <value>] [--sort <value>]
+
+FLAGS
+  -n, --name=<value>        Name of the environment to match on.
+      --pageNumber=<value>  The page number to get. Defaults to 10
+      --pageSize=<value>    The number of environments to get per page. Defaults to 1
+      --sort=<value>        The query (fieldName:<ASC/DESC>) used to sort the environment list in the response.
+
+DESCRIPTION
+  Get a list of all Environments.
+
+  Required token permissions: [ environments:view ]
+
+EXAMPLES
+  $ sc platform env list
+
+  $ sc platform env list --name=Default --pageNumber=1 --pageSize=10 --sort=name:ASC
+```
+
+_See code: [src/commands/platform/env/list.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.1/src/commands/platform/env/list.ts)_
+
+## `sc platform env update`
+
+Modify an environment's attributes
+
+```
+USAGE
+  $ sc platform env update [-d <value>] [-e <value>] [--isDefault] [-n <value>] [--new-name <value>]
+
+FLAGS
+  -d, --desc=<value>      Description of the environment to update.
+  -e, --env-id=<value>    Id of the environment.
+  -n, --name=<value>      Current name of the environment.
+      --isDefault         Indicates this is the organization's default environment. The default value is false.
+      --new-name=<value>  New name of the environment.
+
+DESCRIPTION
+  Modify an environment's attributes
+
+  Use either the Environment's ID (--env-id) or name of the Environment (--name).
+
+  Token Permissions: [ environments:edit ]
+
+
+EXAMPLES
+  $ sc platform env update --name=MyEnvName --new-name=MyNewEnvName --desc="My description to update" --isDefault
+
+  $ sc platform env update --env-id=MyEnvId --new-name=MyNewEnvName --desc="My description to update" --isDefault
+```
+
+_See code: [src/commands/platform/env/update.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.1/src/commands/platform/env/update.ts)_
+
 ## `sc plugins`
 
 List installed plugins.