@dxos/cli 0.1.53-main.ada9e34 → 0.1.53-main.af8b6cb

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (125) hide show
  1. package/README.md +98 -105
  2. package/dist/src/base-command.d.ts +3 -1
  3. package/dist/src/base-command.d.ts.map +1 -1
  4. package/dist/src/base-command.js +24 -14
  5. package/dist/src/base-command.js.map +1 -1
  6. package/dist/src/commands/agent/agent.test.d.ts +2 -0
  7. package/dist/src/commands/agent/agent.test.d.ts.map +1 -0
  8. package/dist/src/commands/agent/agent.test.js +186 -0
  9. package/dist/src/commands/agent/agent.test.js.map +1 -0
  10. package/dist/src/commands/agent/list.d.ts.map +1 -1
  11. package/dist/src/commands/agent/list.js +22 -1
  12. package/dist/src/commands/agent/list.js.map +1 -1
  13. package/dist/src/commands/agent/restart.d.ts +10 -0
  14. package/dist/src/commands/agent/restart.d.ts.map +1 -1
  15. package/dist/src/commands/agent/restart.js +9 -2
  16. package/dist/src/commands/agent/restart.js.map +1 -1
  17. package/dist/src/commands/agent/start.d.ts +1 -0
  18. package/dist/src/commands/agent/start.d.ts.map +1 -1
  19. package/dist/src/commands/agent/start.js +29 -27
  20. package/dist/src/commands/agent/start.js.map +1 -1
  21. package/dist/src/commands/agent/stop.d.ts +2 -0
  22. package/dist/src/commands/agent/stop.d.ts.map +1 -1
  23. package/dist/src/commands/agent/stop.js +17 -7
  24. package/dist/src/commands/agent/stop.js.map +1 -1
  25. package/dist/src/commands/app/create.d.ts +1 -0
  26. package/dist/src/commands/app/create.d.ts.map +1 -1
  27. package/dist/src/commands/app/open.d.ts +1 -0
  28. package/dist/src/commands/app/open.d.ts.map +1 -1
  29. package/dist/src/commands/app/open.js +4 -4
  30. package/dist/src/commands/app/open.js.map +1 -1
  31. package/dist/src/commands/app/publish.d.ts +1 -0
  32. package/dist/src/commands/app/publish.d.ts.map +1 -1
  33. package/dist/src/commands/config/index.d.ts.map +1 -1
  34. package/dist/src/commands/config/index.js +3 -1
  35. package/dist/src/commands/config/index.js.map +1 -1
  36. package/dist/src/commands/debug/stats.d.ts +2 -1
  37. package/dist/src/commands/debug/stats.d.ts.map +1 -1
  38. package/dist/src/commands/debug/stats.js +28 -1
  39. package/dist/src/commands/debug/stats.js.map +1 -1
  40. package/dist/src/commands/function/dev-server.d.ts +2 -1
  41. package/dist/src/commands/function/dev-server.d.ts.map +1 -1
  42. package/dist/src/commands/function/dev-server.js +3 -3
  43. package/dist/src/commands/function/dev-server.js.map +1 -1
  44. package/dist/src/commands/halo/credential/list.d.ts +1 -0
  45. package/dist/src/commands/halo/credential/list.d.ts.map +1 -1
  46. package/dist/src/commands/halo/join.d.ts +1 -0
  47. package/dist/src/commands/halo/join.d.ts.map +1 -1
  48. package/dist/src/commands/halo/join.js +2 -2
  49. package/dist/src/commands/halo/join.js.map +1 -1
  50. package/dist/src/commands/halo/share.d.ts +1 -0
  51. package/dist/src/commands/halo/share.d.ts.map +1 -1
  52. package/dist/src/commands/halo/share.js +4 -4
  53. package/dist/src/commands/halo/share.js.map +1 -1
  54. package/dist/src/commands/kube/deploy.d.ts +1 -0
  55. package/dist/src/commands/kube/deploy.d.ts.map +1 -1
  56. package/dist/src/commands/reset/index.d.ts +1 -0
  57. package/dist/src/commands/reset/index.d.ts.map +1 -1
  58. package/dist/src/commands/reset/index.js +3 -2
  59. package/dist/src/commands/reset/index.js.map +1 -1
  60. package/dist/src/commands/space/create.d.ts.map +1 -1
  61. package/dist/src/commands/space/create.js +2 -29
  62. package/dist/src/commands/space/create.js.map +1 -1
  63. package/dist/src/commands/space/epoch.d.ts +1 -0
  64. package/dist/src/commands/space/epoch.d.ts.map +1 -1
  65. package/dist/src/commands/space/epoch.js +1 -0
  66. package/dist/src/commands/space/epoch.js.map +1 -1
  67. package/dist/src/commands/space/invite.d.ts.map +1 -1
  68. package/dist/src/commands/space/invite.js +3 -2
  69. package/dist/src/commands/space/invite.js.map +1 -1
  70. package/dist/src/commands/space/join.d.ts +1 -0
  71. package/dist/src/commands/space/join.d.ts.map +1 -1
  72. package/dist/src/commands/space/join.js +3 -2
  73. package/dist/src/commands/space/join.js.map +1 -1
  74. package/dist/src/commands/space/list.d.ts +1 -0
  75. package/dist/src/commands/space/list.d.ts.map +1 -1
  76. package/dist/src/commands/space/list.js +1 -0
  77. package/dist/src/commands/space/list.js.map +1 -1
  78. package/dist/src/commands/space/members.d.ts +1 -0
  79. package/dist/src/commands/space/members.d.ts.map +1 -1
  80. package/dist/src/commands/space/members.js +1 -0
  81. package/dist/src/commands/space/members.js.map +1 -1
  82. package/dist/src/commands/tunnel/set.d.ts +1 -0
  83. package/dist/src/commands/tunnel/set.d.ts.map +1 -1
  84. package/dist/src/help.d.ts +6 -0
  85. package/dist/src/help.d.ts.map +1 -0
  86. package/dist/src/help.js +31 -0
  87. package/dist/src/help.js.map +1 -0
  88. package/dist/src/hooks/command-not-found.d.ts +4 -0
  89. package/dist/src/hooks/command-not-found.d.ts.map +1 -0
  90. package/dist/src/hooks/command-not-found.js +14 -0
  91. package/dist/src/hooks/command-not-found.js.map +1 -0
  92. package/dist/src/util/invitation.d.ts +1 -1
  93. package/dist/src/util/invitation.d.ts.map +1 -1
  94. package/dist/src/util/invitation.js +7 -7
  95. package/dist/src/util/invitation.js.map +1 -1
  96. package/dist/src/util/print.d.ts +3 -4
  97. package/dist/src/util/print.d.ts.map +1 -1
  98. package/dist/src/util/print.js +2 -2
  99. package/dist/src/util/print.js.map +1 -1
  100. package/dist/src/util/publish/publisher-rpc-peer.d.ts.map +1 -1
  101. package/dist/src/util/publish/publisher-rpc-peer.js +4 -5
  102. package/dist/src/util/publish/publisher-rpc-peer.js.map +1 -1
  103. package/dist/src/util/supervisor/supervisor-rpc-peer.d.ts.map +1 -1
  104. package/dist/src/util/supervisor/supervisor-rpc-peer.js +4 -5
  105. package/dist/src/util/supervisor/supervisor-rpc-peer.js.map +1 -1
  106. package/dist/src/util/telemetry.d.ts.map +1 -1
  107. package/dist/src/util/telemetry.js.map +1 -1
  108. package/dist/src/util/telemetryrc.json +1 -1
  109. package/dist/src/util/test-util.d.ts +1 -0
  110. package/dist/src/util/test-util.d.ts.map +1 -1
  111. package/dist/src/util/test-util.js +14 -5
  112. package/dist/src/util/test-util.js.map +1 -1
  113. package/dist/src/util/tunnel/tunnel-rpc-peer.d.ts.map +1 -1
  114. package/dist/src/util/tunnel/tunnel-rpc-peer.js +4 -5
  115. package/dist/src/util/tunnel/tunnel-rpc-peer.js.map +1 -1
  116. package/dist/src/util/util.d.ts +1 -1
  117. package/dist/src/util/util.d.ts.map +1 -1
  118. package/dist/src/util/util.js +1 -0
  119. package/dist/src/util/util.js.map +1 -1
  120. package/oclif.manifest.json +37 -113
  121. package/package.json +31 -32
  122. package/dist/src/commands/device/invite.d.ts +0 -6
  123. package/dist/src/commands/device/invite.d.ts.map +0 -1
  124. package/dist/src/commands/device/invite.js +0 -36
  125. package/dist/src/commands/device/invite.js.map +0 -1
package/README.md CHANGED
@@ -2,21 +2,74 @@
2
2
 
3
3
  DXOS command line interface.
4
4
 
5
- TODO(wittjosiah): Add oclif-specific linting rules.
5
+ <!-- toc -->
6
+ * [DX CLI](#dx-cli)
7
+ * [Instalation](#instalation)
8
+ * [Running an Agent](#running-an-agent)
9
+ * [Development](#development)
10
+ * [Usage](#usage)
11
+ <!-- tocstop -->
12
+
13
+ # Instalation
14
+ ```terminal
15
+ npm install -g @dxos/cli@main
16
+ ```
17
+ ---
18
+ # Running an Agent
19
+ Agent is a name for DXOS Client which is run by CLI in the background in the daemonized process.
20
+ ## Starting agent
21
+ Agent is automatically started by each command that requires Client (to avoid this behavior use `--no-agent` flag). You can use `--profile` flag (default value is `default`) to run agent in an isolated profile, and `--foreground` to run agent in attached process.
22
+ ```terminal
23
+ dx agent start
24
+ ```
25
+ see: [dx agent start](#dx-agent-start)
26
+
27
+ ## Adding Agent to your Composer Identity
28
+ 1. Go to [Composer](https://composer.dev.dxos.org). And create a device invitation.
29
+ ![Composer add device](./public/composer-sidebar.png)
30
+ ![Composer invitation](./public/composer-add-device.png)
31
+
32
+ 1. Run halo join command in your terminal.
33
+ ![CLI halo join flow](./public/cli-halo-join.png)
34
+
35
+ 1. Proceed with invitation
36
+
37
+ ## Troubleshooting
38
+ 1. Make sure you are running the latest version of the shared worker in the browser. Go to the shared workers tab chrome://inspect/#workers, kill `dxos-vault` worker, then reload the Composer tab.
39
+ 2. Restart your agent with [```dx agent restart```](#dx-agent-restart). Also useful command[ ```dx agent stop --all```](#dx-agent-stop)
40
+ #### Danger Zone
41
+ 3. Reset Storage. Warning: Agent will lose its storage, and config file will be deleted [```dx reset --force```](#dx-reset)
42
+ ---
43
+
6
44
 
7
45
  # Development
8
46
 
9
- Run the build script from the root directory.
47
+ To build the CLI:
10
48
 
11
49
  ```bash
12
- $ nx run cli:build --watch=true
50
+ nx run cli:build --watch=true
13
51
  ```
14
52
 
15
- Run the CLI in the local directory.
53
+ Run the CLI from the local directory:
16
54
 
17
55
  ```bash
18
- $ export DX_CONFIG=./config/config.yml
19
- $ ./bin/run config --json
56
+ ./bin/run config --json
57
+ ```
58
+
59
+ Or source the following script to set the `dx` alias from any directory in the repo.
60
+
61
+ ```bash
62
+ . $(git rev-parse --show-toplevel)/packages/devtools/cli/scripts/dev.sh
63
+
64
+ dx config --json
65
+ ```
66
+
67
+ ## Reporting errors
68
+
69
+ Run the following command to create a gist of the debug stats.
70
+
71
+ ```bash
72
+ dx debug stats --json --no-agent | gh gist create
20
73
  ```
21
74
 
22
75
  # Usage
@@ -27,7 +80,7 @@ $ npm install -g @dxos/cli
27
80
  $ dx COMMAND
28
81
  running command...
29
82
  $ dx (--version)
30
- @dxos/cli/0.1.53-main.ada9e34 linux-x64 node-v18.16.1
83
+ @dxos/cli/0.1.53-main.af8b6cb linux-x64 node-v18.17.0
31
84
  $ dx --help [COMMAND]
32
85
  USAGE
33
86
  $ dx COMMAND
@@ -35,7 +88,7 @@ USAGE
35
88
  ```
36
89
  <!-- usagestop -->
37
90
 
38
- # Commands
91
+ ## Commands
39
92
 
40
93
  <!-- commands -->
41
94
  * [`dx agent list`](#dx-agent-list)
@@ -49,7 +102,6 @@ USAGE
49
102
  * [`dx config`](#dx-config)
50
103
  * [`dx debug stats`](#dx-debug-stats)
51
104
  * [`dx device`](#dx-device)
52
- * [`dx device invite`](#dx-device-invite)
53
105
  * [`dx device list`](#dx-device-list)
54
106
  * [`dx function dev`](#dx-function-dev)
55
107
  * [`dx function dev-server`](#dx-function-dev-server)
@@ -115,19 +167,19 @@ Restart agent daemon.
115
167
 
116
168
  ```
117
169
  USAGE
118
- $ dx agent restart [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout <value>]
170
+ $ dx agent restart [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
171
+ <value>] [--force]
119
172
 
120
173
  FLAGS
121
174
  -v, --verbose Verbose output
122
175
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
123
176
  --dry-run Dry run.
177
+ --force Force restart.
178
+ --json Output as JSON.
124
179
  --no-agent Auto-start agent.
125
180
  --profile=<value> [default: default] User profile.
126
181
  --timeout=<value> [default: 30] Timeout in seconds.
127
182
 
128
- GLOBAL FLAGS
129
- --json Format output as json.
130
-
131
183
  DESCRIPTION
132
184
  Restart agent daemon.
133
185
  ```
@@ -147,15 +199,13 @@ FLAGS
147
199
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
148
200
  --dry-run Dry run.
149
201
  --echo=port Expose ECHO REST API.
202
+ --json Output as JSON.
150
203
  --monitor Run epoch monitoring.
151
204
  --no-agent Auto-start agent.
152
205
  --profile=<value> [default: default] User profile.
153
206
  --timeout=<value> [default: 30] Timeout in seconds.
154
207
  --web-socket=port Expose web socket port.
155
208
 
156
- GLOBAL FLAGS
157
- --json Format output as json.
158
-
159
209
  DESCRIPTION
160
210
  Starts the agent.
161
211
  ```
@@ -167,20 +217,19 @@ Stop agent daemon.
167
217
  ```
168
218
  USAGE
169
219
  $ dx agent stop [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
170
- <value>] [-a]
220
+ <value>] [--all] [--force]
171
221
 
172
222
  FLAGS
173
- -a, --all Stop all agents.
174
223
  -v, --verbose Verbose output
224
+ --all Stop all agents.
175
225
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
176
226
  --dry-run Dry run.
227
+ --force Force stop.
228
+ --json Output as JSON.
177
229
  --no-agent Auto-start agent.
178
230
  --profile=<value> [default: default] User profile.
179
231
  --timeout=<value> [default: 30] Timeout in seconds.
180
232
 
181
- GLOBAL FLAGS
182
- --json Format output as json.
183
-
184
233
  DESCRIPTION
185
234
  Stop agent daemon.
186
235
  ```
@@ -204,14 +253,12 @@ FLAGS
204
253
  -v, --verbose Verbose output
205
254
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
206
255
  --dry-run Dry run.
256
+ --json Output as JSON.
207
257
  --no-agent Auto-start agent.
208
258
  --profile=<value> [default: default] User profile.
209
259
  --tag=<value> Git tag or branch of the DXOS repo to checkout.
210
260
  --timeout=<value> [default: 30] Timeout in seconds.
211
261
 
212
- GLOBAL FLAGS
213
- --json Format output as json.
214
-
215
262
  DESCRIPTION
216
263
  Manage applications.
217
264
  ```
@@ -283,15 +330,13 @@ FLAGS
283
330
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
284
331
  --configPath=<value> Path to dx.yml
285
332
  --dry-run Dry run.
333
+ --json Output as JSON.
286
334
  --no-agent Auto-start agent.
287
335
  --profile=<value> [default: default] User profile.
288
336
  --skipExisting Do not update content on KUBE if version already exists.
289
337
  --timeout=<value> [default: 30] Timeout in seconds.
290
338
  --version=<value> Version of modules to publish.
291
339
 
292
- GLOBAL FLAGS
293
- --json Format output as json.
294
-
295
340
  DESCRIPTION
296
341
  Publish apps.
297
342
  ```
@@ -325,21 +370,19 @@ Output debug stats.
325
370
 
326
371
  ```
327
372
  USAGE
328
- $ dx debug stats [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
373
+ $ dx debug stats [--json] [--dry-run] [--verbose] [--config <value> --profile <value>] [--no-agent] [--timeout
329
374
  <value>] [--humanize] [--truncate]
330
375
 
331
376
  FLAGS
332
- -v, --verbose Verbose output
333
377
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
334
378
  --dry-run Dry run.
335
379
  --humanize Humanized keys.
380
+ --json Output as JSON.
336
381
  --no-agent Auto-start agent.
337
382
  --profile=<value> [default: default] User profile.
338
383
  --timeout=<value> [default: 30] Timeout in seconds.
339
384
  --truncate Truncate keys.
340
-
341
- GLOBAL FLAGS
342
- --json Format output as json.
385
+ --verbose Verbose output.
343
386
 
344
387
  DESCRIPTION
345
388
  Output debug stats.
@@ -368,29 +411,6 @@ DESCRIPTION
368
411
  Show device info.
369
412
  ```
370
413
 
371
- ## `dx device invite`
372
-
373
- Create device invitation.
374
-
375
- ```
376
- USAGE
377
- $ dx device invite [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout <value>]
378
-
379
- FLAGS
380
- -v, --verbose Verbose output
381
- --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
382
- --dry-run Dry run.
383
- --no-agent Auto-start agent.
384
- --profile=<value> [default: default] User profile.
385
- --timeout=<value> [default: 30] Timeout in seconds.
386
-
387
- GLOBAL FLAGS
388
- --json Format output as json.
389
-
390
- DESCRIPTION
391
- Create device invitation.
392
- ```
393
-
394
414
  ## `dx device list`
395
415
 
396
416
  Show device info.
@@ -427,15 +447,13 @@ FLAGS
427
447
  -v, --verbose Verbose output
428
448
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
429
449
  --dry-run Dry run.
450
+ --json Output as JSON.
430
451
  --manifest=<value> [default: functions.yml]
431
452
  --no-agent Auto-start agent.
432
453
  --profile=<value> [default: default] User profile.
433
- --require=<value>...
454
+ --require=<value>... [default: ts-node/register]
434
455
  --timeout=<value> [default: 30] Timeout in seconds.
435
456
 
436
- GLOBAL FLAGS
437
- --json Format output as json.
438
-
439
457
  DESCRIPTION
440
458
  Development server.
441
459
 
@@ -461,15 +479,13 @@ FLAGS
461
479
  -v, --verbose Verbose output
462
480
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
463
481
  --dry-run Dry run.
482
+ --json Output as JSON.
464
483
  --manifest=<value> [default: functions.yml]
465
484
  --no-agent Auto-start agent.
466
485
  --profile=<value> [default: default] User profile.
467
- --require=<value>...
486
+ --require=<value>... [default: ts-node/register]
468
487
  --timeout=<value> [default: 30] Timeout in seconds.
469
488
 
470
- GLOBAL FLAGS
471
- --json Format output as json.
472
-
473
489
  DESCRIPTION
474
490
  Development server.
475
491
 
@@ -625,13 +641,11 @@ FLAGS
625
641
  -v, --verbose Verbose output
626
642
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
627
643
  --dry-run Dry run.
644
+ --json Output as JSON.
628
645
  --no-agent Auto-start agent.
629
646
  --profile=<value> [default: default] User profile.
630
647
  --timeout=<value> [default: 30] Timeout in seconds.
631
648
 
632
- GLOBAL FLAGS
633
- --json Format output as json.
634
-
635
649
  DESCRIPTION
636
650
  Import credential into HALO.
637
651
  ```
@@ -649,14 +663,12 @@ FLAGS
649
663
  -v, --verbose Verbose output
650
664
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
651
665
  --dry-run Dry run.
666
+ --json Output as JSON.
652
667
  --no-agent Auto-start agent.
653
668
  --profile=<value> [default: default] User profile.
654
669
  --timeout=<value> [default: 30] Timeout in seconds.
655
670
  --type=<value> Type
656
671
 
657
- GLOBAL FLAGS
658
- --json Format output as json.
659
-
660
672
  DESCRIPTION
661
673
  List HALO credentials.
662
674
  ```
@@ -675,13 +687,11 @@ FLAGS
675
687
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
676
688
  --dry-run Dry run.
677
689
  --invitation=<value> Invitation code
690
+ --json Output as JSON.
678
691
  --no-agent Auto-start agent.
679
692
  --profile=<value> [default: default] User profile.
680
693
  --timeout=<value> [default: 30] Timeout in seconds.
681
694
 
682
- GLOBAL FLAGS
683
- --json Format output as json.
684
-
685
695
  DESCRIPTION
686
696
  Join HALO (device) invitation.
687
697
  ```
@@ -729,7 +739,7 @@ DESCRIPTION
729
739
  Display help for dx.
730
740
  ```
731
741
 
732
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.8/src/commands/help.ts)_
742
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.14/src/commands/help.ts)_
733
743
 
734
744
  ## `dx kube auth`
735
745
 
@@ -770,14 +780,12 @@ FLAGS
770
780
  --dev Deploy latest version from dev channel
771
781
  --dry-run Dry run.
772
782
  --hostname=<value> (required) Hostname
783
+ --json Output as JSON.
773
784
  --no-agent Auto-start agent.
774
785
  --profile=<value> [default: default] User profile.
775
786
  --provider=<value> [default: digitalocean] Cloud Provider
776
787
  --timeout=<value> [default: 30] Timeout in seconds.
777
788
 
778
- GLOBAL FLAGS
779
- --json Format output as json.
780
-
781
789
  DESCRIPTION
782
790
  Deploy KUBE.
783
791
  ```
@@ -788,11 +796,14 @@ List installed plugins.
788
796
 
789
797
  ```
790
798
  USAGE
791
- $ dx plugins [--core]
799
+ $ dx plugins [--json] [--core]
792
800
 
793
801
  FLAGS
794
802
  --core Show core plugins.
795
803
 
804
+ GLOBAL FLAGS
805
+ --json Format output as json.
806
+
796
807
  DESCRIPTION
797
808
  List installed plugins.
798
809
 
@@ -800,7 +811,7 @@ EXAMPLES
800
811
  $ dx plugins
801
812
  ```
802
813
 
803
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.3/src/commands/plugins/index.ts)_
814
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/index.ts)_
804
815
 
805
816
  ## `dx plugins:install PLUGIN...`
806
817
 
@@ -1029,13 +1040,11 @@ FLAGS
1029
1040
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
1030
1041
  --dry-run Dry run.
1031
1042
  --force Force delete.
1043
+ --json Output as JSON.
1032
1044
  --no-agent Auto-start agent.
1033
1045
  --profile=<value> [default: default] User profile.
1034
1046
  --timeout=<value> [default: 30] Timeout in seconds.
1035
1047
 
1036
- GLOBAL FLAGS
1037
- --json Format output as json.
1038
-
1039
1048
  DESCRIPTION
1040
1049
  Reset user data.
1041
1050
  ```
@@ -1052,13 +1061,11 @@ FLAGS
1052
1061
  -v, --verbose Verbose output
1053
1062
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
1054
1063
  --dry-run Dry run.
1064
+ --json Output as JSON.
1055
1065
  --no-agent Auto-start agent.
1056
1066
  --profile=<value> [default: default] User profile.
1057
1067
  --timeout=<value> [default: 30] Timeout in seconds.
1058
1068
 
1059
- GLOBAL FLAGS
1060
- --json Format output as json.
1061
-
1062
1069
  DESCRIPTION
1063
1070
  Interactive shell.
1064
1071
  ```
@@ -1075,13 +1082,11 @@ FLAGS
1075
1082
  -v, --verbose Verbose output
1076
1083
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
1077
1084
  --dry-run Dry run.
1085
+ --json Output as JSON.
1078
1086
  --no-agent Auto-start agent.
1079
1087
  --profile=<value> [default: default] User profile.
1080
1088
  --timeout=<value> [default: 30] Timeout in seconds.
1081
1089
 
1082
- GLOBAL FLAGS
1083
- --json Format output as json.
1084
-
1085
1090
  DESCRIPTION
1086
1091
  List spaces.
1087
1092
  ```
@@ -1131,6 +1136,7 @@ FLAGS
1131
1136
  --csv output is csv format [alias: --output=csv]
1132
1137
  --dry-run Dry run.
1133
1138
  --filter=<value> filter property by partial string matching, ex: name=foo
1139
+ --json Output as JSON.
1134
1140
  --no-agent Auto-start agent.
1135
1141
  --no-header hide table header from output
1136
1142
  --no-truncate do not truncate output to fit screen
@@ -1140,9 +1146,6 @@ FLAGS
1140
1146
  --sort=<value> property to sort by (prepend '-' for descending)
1141
1147
  --timeout=<value> [default: 30] Timeout in seconds.
1142
1148
 
1143
- GLOBAL FLAGS
1144
- --json Format output as json.
1145
-
1146
1149
  DESCRIPTION
1147
1150
  Create new epoch.
1148
1151
  ```
@@ -1160,13 +1163,11 @@ FLAGS
1160
1163
  -v, --verbose Verbose output
1161
1164
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
1162
1165
  --dry-run Dry run.
1166
+ --json Output as JSON.
1163
1167
  --no-agent Auto-start agent.
1164
1168
  --profile=<value> [default: default] User profile.
1165
1169
  --timeout=<value> [default: 30] Timeout in seconds.
1166
1170
 
1167
- GLOBAL FLAGS
1168
- --json Format output as json.
1169
-
1170
1171
  DESCRIPTION
1171
1172
  Create space invitation.
1172
1173
  ```
@@ -1185,14 +1186,12 @@ FLAGS
1185
1186
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
1186
1187
  --dry-run Dry run.
1187
1188
  --invitation=<value> Invitation code
1189
+ --json Output as JSON.
1188
1190
  --no-agent Auto-start agent.
1189
1191
  --profile=<value> [default: default] User profile.
1190
1192
  --secret=<value> Invitation secret
1191
1193
  --timeout=<value> [default: 30] Timeout in seconds.
1192
1194
 
1193
- GLOBAL FLAGS
1194
- --json Format output as json.
1195
-
1196
1195
  DESCRIPTION
1197
1196
  Join space invitation
1198
1197
  ```
@@ -1215,6 +1214,7 @@ FLAGS
1215
1214
  --csv output is csv format [alias: --output=csv]
1216
1215
  --dry-run Dry run.
1217
1216
  --filter=<value> filter property by partial string matching, ex: name=foo
1217
+ --json Output as JSON.
1218
1218
  --no-agent Auto-start agent.
1219
1219
  --no-header hide table header from output
1220
1220
  --no-truncate do not truncate output to fit screen
@@ -1224,9 +1224,6 @@ FLAGS
1224
1224
  --sort=<value> property to sort by (prepend '-' for descending)
1225
1225
  --timeout=<value> [default: 30] Timeout in seconds.
1226
1226
 
1227
- GLOBAL FLAGS
1228
- --json Format output as json.
1229
-
1230
1227
  DESCRIPTION
1231
1228
  List spaces.
1232
1229
  ```
@@ -1252,6 +1249,7 @@ FLAGS
1252
1249
  --csv output is csv format [alias: --output=csv]
1253
1250
  --dry-run Dry run.
1254
1251
  --filter=<value> filter property by partial string matching, ex: name=foo
1252
+ --json Output as JSON.
1255
1253
  --no-agent Auto-start agent.
1256
1254
  --no-header hide table header from output
1257
1255
  --no-truncate do not truncate output to fit screen
@@ -1261,9 +1259,6 @@ FLAGS
1261
1259
  --sort=<value> property to sort by (prepend '-' for descending)
1262
1260
  --timeout=<value> [default: 30] Timeout in seconds.
1263
1261
 
1264
- GLOBAL FLAGS
1265
- --json Format output as json.
1266
-
1267
1262
  DESCRIPTION
1268
1263
  List space members.
1269
1264
  ```
@@ -1307,13 +1302,11 @@ FLAGS
1307
1302
  --disabled Disable tunnel.
1308
1303
  --dry-run Dry run.
1309
1304
  --enabled Enable tunnel.
1305
+ --json Output as JSON.
1310
1306
  --no-agent Auto-start agent.
1311
1307
  --profile=<value> [default: default] User profile.
1312
1308
  --timeout=<value> [default: 30] Timeout in seconds.
1313
1309
 
1314
- GLOBAL FLAGS
1315
- --json Format output as json.
1316
-
1317
1310
  DESCRIPTION
1318
1311
  Enable or disable tunnel.
1319
1312
  ```
@@ -7,11 +7,12 @@ export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
7
7
  /**
8
8
  * Custom base command.
9
9
  * https://oclif.io/docs/base_class#docsNav
10
- * Ref: https://github.com/salesforcecli/sf-plugins-core/blob/main/src/sfCommand.ts
10
+ * https://github.com/salesforcecli/sf-plugins-core/blob/main/src/sfCommand.ts
11
11
  */
12
12
  export declare abstract class BaseCommand<T extends typeof Command = any> extends Command {
13
13
  static enableJsonFlag: boolean;
14
14
  static flags: {
15
+ json: Interfaces.BooleanFlag<boolean>;
15
16
  'dry-run': Interfaces.BooleanFlag<boolean>;
16
17
  verbose: Interfaces.BooleanFlag<boolean>;
17
18
  profile: Interfaces.OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
@@ -55,6 +56,7 @@ export declare abstract class BaseCommand<T extends typeof Command = any> extend
55
56
  * https://oclif.io/docs/error_handling
56
57
  */
57
58
  error(err: string | Error, options?: any): never;
59
+ catch(err: Error, options?: any): Promise<void>;
58
60
  /**
59
61
  * Called after each command run.
60
62
  */
@@ -1 +1 @@
1
- {"version":3,"file":"base-command.d.ts","sourceRoot":"","sources":["../../src/base-command.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,WAAW,EAAS,UAAU,EAAE,MAAM,aAAa,CAAC;AAUhF,OAAO,EAAE,MAAM,EAAiB,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,MAAM,EAAa,MAAM,EAAuB,MAAM,cAAc,CAAC;AAS9E,OAAO,EAOL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACd,MAAM,QAAQ,CAAC;AAgBhB,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,OAAO,OAAO,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC,OAAO,WAAW,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AACvH,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,OAAO,OAAO,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEhF;;;;GAIG;AACH,8BAAsB,WAAW,CAAC,CAAC,SAAS,OAAO,OAAO,GAAG,GAAG,CAAE,SAAQ,OAAO;IAC/E,OAAuB,cAAc,UAAQ;IAE7C,OAAgB,KAAK;;;;;;;MAyCnB;IAEF,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,UAAU,CAAO;IACzB,OAAO,CAAC,QAAQ,CAAS;IAEzB,SAAS,CAAC,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IAE/C,SAAS,CAAC,KAAK,EAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3B,SAAS,CAAC,IAAI,EAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBAEb,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,WAAW;IAY/C,IAAI,YAAY,WAGf;IAED,IAAI,KAAK,uBAER;IAED,IAAI,QAAQ,WAEX;IAED,IAAI;IAIJ;;OAEG;IACY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;YAkBtB,cAAc;YAiDd,WAAW;IA8BzB;;;OAGG;IACM,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAI5C;;;OAGG;IACM,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK;IAQjC;;;;;OAKG;IACM,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,KAAK;IAOzD;;OAEG;IACY,OAAO;IAchB,gBAAgB;IAYtB;;OAEG;IACG,SAAS;IAkBf;;OAEG;IACG,cAAc,CAAC,CAAC,EACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,EACpD,SAAS,UAAQ,GAChB,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAYzB;;OAEG;IACG,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAQrG;;OAEG;IACG,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAkBzG,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAkBtG,kBAAkB,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAkBjH,qBAAqB,CAAC,MAAM,EAAE,MAAM;CAUrC"}
1
+ {"version":3,"file":"base-command.d.ts","sourceRoot":"","sources":["../../src/base-command.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,WAAW,EAAS,UAAU,EAAE,MAAM,aAAa,CAAC;AAUhF,OAAO,EAAE,MAAM,EAAiB,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAiB9C,OAAO,EAOL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACd,MAAM,QAAQ,CAAC;AAkBhB,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,OAAO,OAAO,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC,OAAO,WAAW,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AACvH,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,OAAO,OAAO,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEhF;;;;GAIG;AACH,8BAAsB,WAAW,CAAC,CAAC,SAAS,OAAO,OAAO,GAAG,GAAG,CAAE,SAAQ,OAAO;IAC/E,OAAuB,cAAc,UAAQ;IAE7C,OAAgB,KAAK;;;;;;;;MA+CnB;IAEF,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,UAAU,CAAO;IACzB,OAAO,CAAC,QAAQ,CAAS;IAEzB,SAAS,CAAC,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IAE/C,SAAS,CAAC,KAAK,EAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3B,SAAS,CAAC,IAAI,EAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBAEb,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,WAAW;IAY/C,IAAI,YAAY,WAGf;IAED,IAAI,KAAK,uBAER;IAED,IAAI,QAAQ,WAEX;IAED,IAAI;IAIJ;;OAEG;IACY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;YAkBtB,cAAc;YAgDd,WAAW;IA8BzB;;;OAGG;IACM,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAI5C;;;OAGG;IACM,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK;IAQjC;;;;;OAKG;IACM,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,KAAK;IAK1C,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,GAAG;IAO9C;;OAEG;IACY,OAAO;IAahB,gBAAgB;IAYtB;;OAEG;IACG,SAAS;IAiBf;;OAEG;IACG,cAAc,CAAC,CAAC,EACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,EACpD,SAAS,UAAQ,GAChB,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAYzB;;OAEG;IACG,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAQrG;;OAEG;IACG,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAkBzG,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAkBtG,kBAAkB,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAkBjH,qBAAqB,CAAC,MAAM,EAAE,MAAM;CAUrC"}