Skip to content

Commit f487502

Browse files
0.0.4
1 parent 8df9d00 commit f487502

File tree

3 files changed

+77
-37
lines changed

3 files changed

+77
-37
lines changed

README.md

Lines changed: 74 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ $ npm install -g @dishantlangayan/solace-cloud-cli
2222
$ sc COMMAND
2323
running command...
2424
$ sc (--version)
25-
@dishantlangayan/solace-cloud-cli/0.0.3 darwin-x64 node-v23.10.0
25+
@dishantlangayan/solace-cloud-cli/0.0.4 darwin-arm64 node-v24.1.0
2626
$ sc --help [COMMAND]
2727
USAGE
2828
$ sc COMMAND
@@ -51,6 +51,7 @@ The following Environment variables are optional:
5151
* [`sc missionctrl broker display`](#sc-missionctrl-broker-display)
5252
* [`sc missionctrl broker list`](#sc-missionctrl-broker-list)
5353
* [`sc missionctrl broker opstatus`](#sc-missionctrl-broker-opstatus)
54+
* [`sc missionctrl broker update`](#sc-missionctrl-broker-update)
5455
* [`sc platform env create`](#sc-platform-env-create)
5556
* [`sc platform env delete`](#sc-platform-env-delete)
5657
* [`sc platform env display`](#sc-platform-env-display)
@@ -144,7 +145,7 @@ EXAMPLES
144145
$ sc missionctrl broker create --name=MyBrokerName --datacenter-id=eks-ca-central-1a --service-class-id=DEVELOPER
145146
```
146147

147-
_See code: [src/commands/missionctrl/broker/create.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/missionctrl/broker/create.ts)_
148+
_See code: [src/commands/missionctrl/broker/create.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/missionctrl/broker/create.ts)_
148149

149150
## `sc missionctrl broker delete`
150151

@@ -176,7 +177,7 @@ EXAMPLES
176177
$ sc missionctrl broker delete --name=MyBrokerName
177178
```
178179

179-
_See code: [src/commands/missionctrl/broker/delete.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/missionctrl/broker/delete.ts)_
180+
_See code: [src/commands/missionctrl/broker/delete.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/missionctrl/broker/delete.ts)_
180181

181182
## `sc missionctrl broker display`
182183

@@ -207,7 +208,7 @@ EXAMPLES
207208
$ sc missionctrl broker display
208209
```
209210

210-
_See code: [src/commands/missionctrl/broker/display.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/missionctrl/broker/display.ts)_
211+
_See code: [src/commands/missionctrl/broker/display.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/missionctrl/broker/display.ts)_
211212

212213
## `sc missionctrl broker list`
213214

@@ -253,41 +254,80 @@ EXAMPLES
253254
$ sc missionctrl broker list --name=MyBrokerName --pageNumber=1 --pageSize=10 --sort=name:asc
254255
```
255256

256-
_See code: [src/commands/missionctrl/broker/list.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/missionctrl/broker/list.ts)_
257+
_See code: [src/commands/missionctrl/broker/list.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/missionctrl/broker/list.ts)_
257258

258259
## `sc missionctrl broker opstatus`
259260

260-
Get the status of an operation that being performed on an event broker service.
261+
Get the status of all operations being performed on an event broker service.
261262

262263
```
263264
USAGE
264-
$ sc missionctrl broker opstatus [--json] [--log-level debug|warn|error|info|trace] [-b <value>] [-n <value>] [-o
265-
<value>] [-p]
265+
$ sc missionctrl broker opstatus [--json] [--log-level debug|warn|error|info|trace] [-b <value>] [-n <value>] [-p] [-w
266+
<value>]
266267
267268
FLAGS
268-
-b, --broker-id=<value> Id of the event broker service.
269-
-n, --name=<value> Name of the event broker service.
270-
-o, --operation-id=<value> The identifier of the operation being performed on the event broker service.
271-
-p, --show-progress Displays a status bar of the in-progress operation. The command will wait for completion
272-
of each step of the operation.
269+
-b, --broker-id=<value> Id of the event broker service.
270+
-n, --name=<value> Name of the event broker service.
271+
-p, --show-progress Displays a status bar of the in-progress operations. The command will wait for completion of
272+
each step of the operation.
273+
-w, --wait-ms=<value> The milliseconds to wait between API calls for checking progress of the operation. Default is
274+
5000 ms.
273275
274276
GLOBAL FLAGS
275277
--json Format output as json.
276278
--log-level=<option> [default: info] Specify level for logging.
277279
<options: debug|warn|error|info|trace>
278280
279281
DESCRIPTION
280-
Get the status of an operation that being performed on an event broker service.
281-
To get the operation, you provide identifier of the operation and the identifier of the event broker service.
282+
Get the status of all operations being performed on an event broker service.
283+
To get the operation status, you must provide the identifier or name of the event broker service.
282284
283285
Token Permissions: [ mission_control:access or services:get or services:get:self or services:view or
284286
services:view:self ]
285287
286288
EXAMPLES
287-
$ sc missionctrl broker opstatus
289+
$ sc missionctrl broker opstatus -b <broker-id>
290+
291+
$ sc missionctrl broker opstatus -n <broker-name>
292+
```
293+
294+
_See code: [src/commands/missionctrl/broker/opstatus.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/missionctrl/broker/opstatus.ts)_
295+
296+
## `sc missionctrl broker update`
297+
298+
Update the configuration of an existing event broker service.
299+
300+
```
301+
USAGE
302+
$ sc missionctrl broker update [--json] [--log-level debug|warn|error|info|trace] [-b <value>] [-l <value>] [-n <value>]
303+
[--new-name <value>]
304+
305+
FLAGS
306+
-b, --broker-id=<value> Id of the event broker service.
307+
-l, --locked=<value> Indicates whether the event broker service has deletion protection enabled. The valid values
308+
are 'true' (enabled) or 'false' (disabled).
309+
-n, --name=<value> Name of the event broker service.
310+
--new-name=<value> New name of the event broker service. The new service name must be unique within an
311+
organization.
312+
313+
GLOBAL FLAGS
314+
--json Format output as json.
315+
--log-level=<option> [default: info] Specify level for logging.
316+
<options: debug|warn|error|info|trace>
317+
318+
DESCRIPTION
319+
Update the configuration of an existing event broker service.
320+
You can provide any combination of supported flags. If a flag is not provided, then it will not be updated.
321+
322+
Your token must have one of the permissions listed in the Token Permissions.
323+
324+
Token Permissions: [ mission_control:access or services:put ]
325+
326+
EXAMPLES
327+
$ sc missionctrl broker update
288328
```
289329

290-
_See code: [src/commands/missionctrl/broker/opstatus.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/missionctrl/broker/opstatus.ts)_
330+
_See code: [src/commands/missionctrl/broker/update.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/missionctrl/broker/update.ts)_
291331

292332
## `sc platform env create`
293333

@@ -299,13 +339,13 @@ USAGE
299339
[--isProduction]
300340
301341
FLAGS
302-
-d, --desc=<value> Description of the environment to create.
303-
-n, --name=<value> (required) Name of the environment to create.
304-
--isDefault Indicates this is the organization’s default environment.
305-
--isProduction Indicates this is an organization’s production environment.
306-
This is an immutable field. If an environment needs to be migrated,
307-
architecture can be migrated to a new environment with the desired
308-
environment type instead.
342+
-d, --description=<value> Description of the environment to create.
343+
-n, --name=<value> (required) Name of the environment to create.
344+
--isDefault Indicates this is the organization’s default environment.
345+
--isProduction Indicates this is an organization’s production environment.
346+
This is an immutable field. If an environment needs to be migrated,
347+
architecture can be migrated to a new environment with the desired
348+
environment type instead.
309349
310350
GLOBAL FLAGS
311351
--json Format output as json.
@@ -321,7 +361,7 @@ EXAMPLES
321361
$ sc platform env create --name=MyEnvironment --desc="My environment description" --isDefault --isProduction
322362
```
323363

324-
_See code: [src/commands/platform/env/create.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/platform/env/create.ts)_
364+
_See code: [src/commands/platform/env/create.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/platform/env/create.ts)_
325365

326366
## `sc platform env delete`
327367

@@ -351,7 +391,7 @@ EXAMPLES
351391
$ sc platform env delete --env-id=MyEnvId
352392
```
353393

354-
_See code: [src/commands/platform/env/delete.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/platform/env/delete.ts)_
394+
_See code: [src/commands/platform/env/delete.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/platform/env/delete.ts)_
355395

356396
## `sc platform env display`
357397

@@ -383,7 +423,7 @@ EXAMPLES
383423
$ sc platform env display --env-id=MyEnvId
384424
```
385425

386-
_See code: [src/commands/platform/env/display.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/platform/env/display.ts)_
426+
_See code: [src/commands/platform/env/display.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/platform/env/display.ts)_
387427

388428
## `sc platform env list`
389429

@@ -416,7 +456,7 @@ EXAMPLES
416456
$ sc platform env list --name=Default --pageNumber=1 --pageSize=10 --sort=name:ASC
417457
```
418458

419-
_See code: [src/commands/platform/env/list.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/platform/env/list.ts)_
459+
_See code: [src/commands/platform/env/list.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/platform/env/list.ts)_
420460

421461
## `sc platform env update`
422462

@@ -428,11 +468,11 @@ USAGE
428468
<value>] [--new-name <value>]
429469
430470
FLAGS
431-
-d, --desc=<value> Description of the environment to update.
432-
-e, --env-id=<value> Id of the environment.
433-
-n, --name=<value> Current name of the environment.
434-
--isDefault Indicates this is the organization's default environment. The default value is false.
435-
--new-name=<value> New name of the environment.
471+
-d, --description=<value> Description of the environment to update.
472+
-e, --env-id=<value> Id of the environment.
473+
-n, --name=<value> Current name of the environment.
474+
--isDefault Indicates this is the organization's default environment. The default value is false.
475+
--new-name=<value> New name of the environment.
436476
437477
GLOBAL FLAGS
438478
--json Format output as json.
@@ -453,7 +493,7 @@ EXAMPLES
453493
$ sc platform env update --env-id=MyEnvId --new-name=MyNewEnvName --desc="My description to update" --isDefault
454494
```
455495

456-
_See code: [src/commands/platform/env/update.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.3/src/commands/platform/env/update.ts)_
496+
_See code: [src/commands/platform/env/update.ts](https://github.com/dishantlangayan/solace-cloud-cli/blob/v0.0.4/src/commands/platform/env/update.ts)_
457497

458498
## `sc plugins`
459499

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@dishantlangayan/solace-cloud-cli",
33
"description": "The Solace Cloud CLI",
4-
"version": "0.0.3",
4+
"version": "0.0.4",
55
"author": "Dishant Langayan",
66
"bin": {
77
"sc": "./bin/run.js"

0 commit comments

Comments
 (0)