@dxos/cli 0.1.53 → 0.1.54-main.270ec56
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.
- package/README.md +96 -133
- package/dist/src/base-command.d.ts +3 -1
- package/dist/src/base-command.d.ts.map +1 -1
- package/dist/src/base-command.js +24 -14
- package/dist/src/base-command.js.map +1 -1
- package/dist/src/commands/agent/agent.test.d.ts +2 -0
- package/dist/src/commands/agent/agent.test.d.ts.map +1 -0
- package/dist/src/commands/agent/agent.test.js +186 -0
- package/dist/src/commands/agent/agent.test.js.map +1 -0
- package/dist/src/commands/agent/list.d.ts.map +1 -1
- package/dist/src/commands/agent/list.js +22 -1
- package/dist/src/commands/agent/list.js.map +1 -1
- package/dist/src/commands/agent/restart.d.ts +10 -0
- package/dist/src/commands/agent/restart.d.ts.map +1 -1
- package/dist/src/commands/agent/restart.js +9 -2
- package/dist/src/commands/agent/restart.js.map +1 -1
- package/dist/src/commands/agent/start.d.ts +1 -0
- package/dist/src/commands/agent/start.d.ts.map +1 -1
- package/dist/src/commands/agent/start.js +29 -27
- package/dist/src/commands/agent/start.js.map +1 -1
- package/dist/src/commands/agent/stop.d.ts +2 -0
- package/dist/src/commands/agent/stop.d.ts.map +1 -1
- package/dist/src/commands/agent/stop.js +17 -7
- package/dist/src/commands/agent/stop.js.map +1 -1
- package/dist/src/commands/app/create.d.ts +1 -0
- package/dist/src/commands/app/create.d.ts.map +1 -1
- package/dist/src/commands/app/open.d.ts +1 -0
- package/dist/src/commands/app/open.d.ts.map +1 -1
- package/dist/src/commands/app/open.js +6 -6
- package/dist/src/commands/app/open.js.map +1 -1
- package/dist/src/commands/app/publish.d.ts +1 -0
- package/dist/src/commands/app/publish.d.ts.map +1 -1
- package/dist/src/commands/config/index.d.ts.map +1 -1
- package/dist/src/commands/config/index.js +3 -1
- package/dist/src/commands/config/index.js.map +1 -1
- package/dist/src/commands/debug/stats.d.ts +1 -0
- package/dist/src/commands/debug/stats.d.ts.map +1 -1
- package/dist/src/commands/debug/stats.js +21 -16
- package/dist/src/commands/debug/stats.js.map +1 -1
- package/dist/src/commands/function/dev-server.d.ts +2 -1
- package/dist/src/commands/function/dev-server.d.ts.map +1 -1
- package/dist/src/commands/function/dev-server.js +3 -3
- package/dist/src/commands/function/dev-server.js.map +1 -1
- package/dist/src/commands/halo/credential/list.d.ts +1 -0
- package/dist/src/commands/halo/credential/list.d.ts.map +1 -1
- package/dist/src/commands/halo/join.d.ts +1 -0
- package/dist/src/commands/halo/join.d.ts.map +1 -1
- package/dist/src/commands/halo/join.js +2 -2
- package/dist/src/commands/halo/join.js.map +1 -1
- package/dist/src/commands/halo/share.d.ts +1 -0
- package/dist/src/commands/halo/share.d.ts.map +1 -1
- package/dist/src/commands/halo/share.js +4 -4
- package/dist/src/commands/halo/share.js.map +1 -1
- package/dist/src/commands/kube/deploy.d.ts +1 -0
- package/dist/src/commands/kube/deploy.d.ts.map +1 -1
- package/dist/src/commands/reset/index.d.ts +1 -0
- package/dist/src/commands/reset/index.d.ts.map +1 -1
- package/dist/src/commands/reset/index.js +1 -1
- package/dist/src/commands/reset/index.js.map +1 -1
- package/dist/src/commands/space/create.d.ts.map +1 -1
- package/dist/src/commands/space/create.js +1 -29
- package/dist/src/commands/space/create.js.map +1 -1
- package/dist/src/commands/space/epoch.d.ts +1 -0
- package/dist/src/commands/space/epoch.d.ts.map +1 -1
- package/dist/src/commands/space/invite.d.ts.map +1 -1
- package/dist/src/commands/space/invite.js +2 -2
- package/dist/src/commands/space/invite.js.map +1 -1
- package/dist/src/commands/space/join.d.ts +1 -0
- package/dist/src/commands/space/join.d.ts.map +1 -1
- package/dist/src/commands/space/join.js +2 -2
- package/dist/src/commands/space/join.js.map +1 -1
- package/dist/src/commands/space/list.d.ts +1 -0
- package/dist/src/commands/space/list.d.ts.map +1 -1
- package/dist/src/commands/space/members.d.ts +1 -0
- package/dist/src/commands/space/members.d.ts.map +1 -1
- package/dist/src/commands/tunnel/set.d.ts +1 -0
- package/dist/src/commands/tunnel/set.d.ts.map +1 -1
- package/dist/src/help.d.ts +6 -0
- package/dist/src/help.d.ts.map +1 -0
- package/dist/src/help.js +31 -0
- package/dist/src/help.js.map +1 -0
- package/dist/src/hooks/command-not-found.d.ts +4 -0
- package/dist/src/hooks/command-not-found.d.ts.map +1 -0
- package/dist/src/hooks/command-not-found.js +14 -0
- package/dist/src/hooks/command-not-found.js.map +1 -0
- package/dist/src/util/invitation.d.ts +1 -1
- package/dist/src/util/invitation.d.ts.map +1 -1
- package/dist/src/util/invitation.js +7 -7
- package/dist/src/util/invitation.js.map +1 -1
- package/dist/src/util/print.d.ts +3 -4
- package/dist/src/util/print.d.ts.map +1 -1
- package/dist/src/util/print.js +2 -2
- package/dist/src/util/print.js.map +1 -1
- package/dist/src/util/publish/publisher-rpc-peer.d.ts.map +1 -1
- package/dist/src/util/publish/publisher-rpc-peer.js +4 -5
- package/dist/src/util/publish/publisher-rpc-peer.js.map +1 -1
- package/dist/src/util/supervisor/supervisor-rpc-peer.d.ts.map +1 -1
- package/dist/src/util/supervisor/supervisor-rpc-peer.js +4 -5
- package/dist/src/util/supervisor/supervisor-rpc-peer.js.map +1 -1
- package/dist/src/util/telemetry.d.ts.map +1 -1
- package/dist/src/util/telemetry.js.map +1 -1
- package/dist/src/util/telemetryrc.json +2 -2
- package/dist/src/util/test-util.d.ts +1 -0
- package/dist/src/util/test-util.d.ts.map +1 -1
- package/dist/src/util/test-util.js +14 -5
- package/dist/src/util/test-util.js.map +1 -1
- package/dist/src/util/tunnel/tunnel-rpc-peer.d.ts.map +1 -1
- package/dist/src/util/tunnel/tunnel-rpc-peer.js +4 -5
- package/dist/src/util/tunnel/tunnel-rpc-peer.js.map +1 -1
- package/dist/src/util/util.d.ts +1 -1
- package/dist/src/util/util.d.ts.map +1 -1
- package/oclif.manifest.json +36 -199
- package/package.json +31 -32
- package/dist/src/commands/debug/echo-test-data.d.ts +0 -19
- package/dist/src/commands/debug/echo-test-data.d.ts.map +0 -1
- package/dist/src/commands/debug/echo-test-data.js +0 -63
- package/dist/src/commands/debug/echo-test-data.js.map +0 -1
- package/dist/src/commands/device/invite.d.ts +0 -6
- package/dist/src/commands/device/invite.d.ts.map +0 -1
- package/dist/src/commands/device/invite.js +0 -36
- 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
|
-
|
|
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
|
+

|
|
30
|
+

|
|
31
|
+
|
|
32
|
+
1. Run halo join command in your terminal.
|
|
33
|
+

|
|
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
|
-
|
|
47
|
+
To build the CLI:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
nx run cli:build --watch=true
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Run the CLI from the local directory:
|
|
10
54
|
|
|
11
55
|
```bash
|
|
12
|
-
|
|
56
|
+
./bin/run config --json
|
|
13
57
|
```
|
|
14
58
|
|
|
15
|
-
|
|
59
|
+
Or source the following script to set the `dx` alias from any directory in the repo.
|
|
16
60
|
|
|
17
61
|
```bash
|
|
18
|
-
$
|
|
19
|
-
|
|
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.
|
|
83
|
+
@dxos/cli/0.1.54-main.270ec56 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
|
-
|
|
91
|
+
## Commands
|
|
39
92
|
|
|
40
93
|
<!-- commands -->
|
|
41
94
|
* [`dx agent list`](#dx-agent-list)
|
|
@@ -47,10 +100,8 @@ USAGE
|
|
|
47
100
|
* [`dx app open URL`](#dx-app-open-url)
|
|
48
101
|
* [`dx app publish`](#dx-app-publish)
|
|
49
102
|
* [`dx config`](#dx-config)
|
|
50
|
-
* [`dx debug echo-test-data [KEY]`](#dx-debug-echo-test-data-key)
|
|
51
103
|
* [`dx debug stats`](#dx-debug-stats)
|
|
52
104
|
* [`dx device`](#dx-device)
|
|
53
|
-
* [`dx device invite`](#dx-device-invite)
|
|
54
105
|
* [`dx device list`](#dx-device-list)
|
|
55
106
|
* [`dx function dev`](#dx-function-dev)
|
|
56
107
|
* [`dx function dev-server`](#dx-function-dev-server)
|
|
@@ -116,19 +167,19 @@ Restart agent daemon.
|
|
|
116
167
|
|
|
117
168
|
```
|
|
118
169
|
USAGE
|
|
119
|
-
$ dx agent restart [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
|
|
170
|
+
$ dx agent restart [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
|
|
171
|
+
<value>] [--force]
|
|
120
172
|
|
|
121
173
|
FLAGS
|
|
122
174
|
-v, --verbose Verbose output
|
|
123
175
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
124
176
|
--dry-run Dry run.
|
|
177
|
+
--force Force restart.
|
|
178
|
+
--json Output as JSON.
|
|
125
179
|
--no-agent Auto-start agent.
|
|
126
180
|
--profile=<value> [default: default] User profile.
|
|
127
181
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
128
182
|
|
|
129
|
-
GLOBAL FLAGS
|
|
130
|
-
--json Format output as json.
|
|
131
|
-
|
|
132
183
|
DESCRIPTION
|
|
133
184
|
Restart agent daemon.
|
|
134
185
|
```
|
|
@@ -148,15 +199,13 @@ FLAGS
|
|
|
148
199
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
149
200
|
--dry-run Dry run.
|
|
150
201
|
--echo=port Expose ECHO REST API.
|
|
202
|
+
--json Output as JSON.
|
|
151
203
|
--monitor Run epoch monitoring.
|
|
152
204
|
--no-agent Auto-start agent.
|
|
153
205
|
--profile=<value> [default: default] User profile.
|
|
154
206
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
155
207
|
--web-socket=port Expose web socket port.
|
|
156
208
|
|
|
157
|
-
GLOBAL FLAGS
|
|
158
|
-
--json Format output as json.
|
|
159
|
-
|
|
160
209
|
DESCRIPTION
|
|
161
210
|
Starts the agent.
|
|
162
211
|
```
|
|
@@ -168,20 +217,19 @@ Stop agent daemon.
|
|
|
168
217
|
```
|
|
169
218
|
USAGE
|
|
170
219
|
$ dx agent stop [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
|
|
171
|
-
<value>] [
|
|
220
|
+
<value>] [--all] [--force]
|
|
172
221
|
|
|
173
222
|
FLAGS
|
|
174
|
-
-a, --all Stop all agents.
|
|
175
223
|
-v, --verbose Verbose output
|
|
224
|
+
--all Stop all agents.
|
|
176
225
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
177
226
|
--dry-run Dry run.
|
|
227
|
+
--force Force stop.
|
|
228
|
+
--json Output as JSON.
|
|
178
229
|
--no-agent Auto-start agent.
|
|
179
230
|
--profile=<value> [default: default] User profile.
|
|
180
231
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
181
232
|
|
|
182
|
-
GLOBAL FLAGS
|
|
183
|
-
--json Format output as json.
|
|
184
|
-
|
|
185
233
|
DESCRIPTION
|
|
186
234
|
Stop agent daemon.
|
|
187
235
|
```
|
|
@@ -205,14 +253,12 @@ FLAGS
|
|
|
205
253
|
-v, --verbose Verbose output
|
|
206
254
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
207
255
|
--dry-run Dry run.
|
|
256
|
+
--json Output as JSON.
|
|
208
257
|
--no-agent Auto-start agent.
|
|
209
258
|
--profile=<value> [default: default] User profile.
|
|
210
259
|
--tag=<value> Git tag or branch of the DXOS repo to checkout.
|
|
211
260
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
212
261
|
|
|
213
|
-
GLOBAL FLAGS
|
|
214
|
-
--json Format output as json.
|
|
215
|
-
|
|
216
262
|
DESCRIPTION
|
|
217
263
|
Manage applications.
|
|
218
264
|
```
|
|
@@ -284,15 +330,13 @@ FLAGS
|
|
|
284
330
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
285
331
|
--configPath=<value> Path to dx.yml
|
|
286
332
|
--dry-run Dry run.
|
|
333
|
+
--json Output as JSON.
|
|
287
334
|
--no-agent Auto-start agent.
|
|
288
335
|
--profile=<value> [default: default] User profile.
|
|
289
336
|
--skipExisting Do not update content on KUBE if version already exists.
|
|
290
337
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
291
338
|
--version=<value> Version of modules to publish.
|
|
292
339
|
|
|
293
|
-
GLOBAL FLAGS
|
|
294
|
-
--json Format output as json.
|
|
295
|
-
|
|
296
340
|
DESCRIPTION
|
|
297
341
|
Publish apps.
|
|
298
342
|
```
|
|
@@ -320,35 +364,6 @@ DESCRIPTION
|
|
|
320
364
|
Show config file.
|
|
321
365
|
```
|
|
322
366
|
|
|
323
|
-
## `dx debug echo-test-data [KEY]`
|
|
324
|
-
|
|
325
|
-
Pollutes selected space with test data.
|
|
326
|
-
|
|
327
|
-
```
|
|
328
|
-
USAGE
|
|
329
|
-
$ dx debug echo-test-data [KEY] [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
|
|
330
|
-
<value>] [--mutations <value>] [--epochEach <value>]
|
|
331
|
-
|
|
332
|
-
ARGUMENTS
|
|
333
|
-
KEY Space key head in hex.
|
|
334
|
-
|
|
335
|
-
FLAGS
|
|
336
|
-
-v, --verbose Verbose output
|
|
337
|
-
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
338
|
-
--dry-run Dry run.
|
|
339
|
-
--epochEach=<value> [default: 100] Epoch each N mutations.
|
|
340
|
-
--mutations=<value> [default: 10000] Number of mutations.
|
|
341
|
-
--no-agent Auto-start agent.
|
|
342
|
-
--profile=<value> [default: default] User profile.
|
|
343
|
-
--timeout=<value> [default: 30] Timeout in seconds.
|
|
344
|
-
|
|
345
|
-
GLOBAL FLAGS
|
|
346
|
-
--json Format output as json.
|
|
347
|
-
|
|
348
|
-
DESCRIPTION
|
|
349
|
-
Pollutes selected space with test data.
|
|
350
|
-
```
|
|
351
|
-
|
|
352
367
|
## `dx debug stats`
|
|
353
368
|
|
|
354
369
|
Output debug stats.
|
|
@@ -362,15 +377,13 @@ FLAGS
|
|
|
362
377
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
363
378
|
--dry-run Dry run.
|
|
364
379
|
--humanize Humanized keys.
|
|
380
|
+
--json Output as JSON.
|
|
365
381
|
--no-agent Auto-start agent.
|
|
366
382
|
--profile=<value> [default: default] User profile.
|
|
367
383
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
368
384
|
--truncate Truncate keys.
|
|
369
385
|
--verbose Verbose output.
|
|
370
386
|
|
|
371
|
-
GLOBAL FLAGS
|
|
372
|
-
--json Format output as json.
|
|
373
|
-
|
|
374
387
|
DESCRIPTION
|
|
375
388
|
Output debug stats.
|
|
376
389
|
```
|
|
@@ -398,29 +411,6 @@ DESCRIPTION
|
|
|
398
411
|
Show device info.
|
|
399
412
|
```
|
|
400
413
|
|
|
401
|
-
## `dx device invite`
|
|
402
|
-
|
|
403
|
-
Create device invitation.
|
|
404
|
-
|
|
405
|
-
```
|
|
406
|
-
USAGE
|
|
407
|
-
$ dx device invite [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout <value>]
|
|
408
|
-
|
|
409
|
-
FLAGS
|
|
410
|
-
-v, --verbose Verbose output
|
|
411
|
-
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
412
|
-
--dry-run Dry run.
|
|
413
|
-
--no-agent Auto-start agent.
|
|
414
|
-
--profile=<value> [default: default] User profile.
|
|
415
|
-
--timeout=<value> [default: 30] Timeout in seconds.
|
|
416
|
-
|
|
417
|
-
GLOBAL FLAGS
|
|
418
|
-
--json Format output as json.
|
|
419
|
-
|
|
420
|
-
DESCRIPTION
|
|
421
|
-
Create device invitation.
|
|
422
|
-
```
|
|
423
|
-
|
|
424
414
|
## `dx device list`
|
|
425
415
|
|
|
426
416
|
Show device info.
|
|
@@ -457,15 +447,13 @@ FLAGS
|
|
|
457
447
|
-v, --verbose Verbose output
|
|
458
448
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
459
449
|
--dry-run Dry run.
|
|
450
|
+
--json Output as JSON.
|
|
460
451
|
--manifest=<value> [default: functions.yml]
|
|
461
452
|
--no-agent Auto-start agent.
|
|
462
453
|
--profile=<value> [default: default] User profile.
|
|
463
|
-
--require=<value>...
|
|
454
|
+
--require=<value>... [default: ts-node/register]
|
|
464
455
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
465
456
|
|
|
466
|
-
GLOBAL FLAGS
|
|
467
|
-
--json Format output as json.
|
|
468
|
-
|
|
469
457
|
DESCRIPTION
|
|
470
458
|
Development server.
|
|
471
459
|
|
|
@@ -491,15 +479,13 @@ FLAGS
|
|
|
491
479
|
-v, --verbose Verbose output
|
|
492
480
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
493
481
|
--dry-run Dry run.
|
|
482
|
+
--json Output as JSON.
|
|
494
483
|
--manifest=<value> [default: functions.yml]
|
|
495
484
|
--no-agent Auto-start agent.
|
|
496
485
|
--profile=<value> [default: default] User profile.
|
|
497
|
-
--require=<value>...
|
|
486
|
+
--require=<value>... [default: ts-node/register]
|
|
498
487
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
499
488
|
|
|
500
|
-
GLOBAL FLAGS
|
|
501
|
-
--json Format output as json.
|
|
502
|
-
|
|
503
489
|
DESCRIPTION
|
|
504
490
|
Development server.
|
|
505
491
|
|
|
@@ -655,13 +641,11 @@ FLAGS
|
|
|
655
641
|
-v, --verbose Verbose output
|
|
656
642
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
657
643
|
--dry-run Dry run.
|
|
644
|
+
--json Output as JSON.
|
|
658
645
|
--no-agent Auto-start agent.
|
|
659
646
|
--profile=<value> [default: default] User profile.
|
|
660
647
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
661
648
|
|
|
662
|
-
GLOBAL FLAGS
|
|
663
|
-
--json Format output as json.
|
|
664
|
-
|
|
665
649
|
DESCRIPTION
|
|
666
650
|
Import credential into HALO.
|
|
667
651
|
```
|
|
@@ -679,14 +663,12 @@ FLAGS
|
|
|
679
663
|
-v, --verbose Verbose output
|
|
680
664
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
681
665
|
--dry-run Dry run.
|
|
666
|
+
--json Output as JSON.
|
|
682
667
|
--no-agent Auto-start agent.
|
|
683
668
|
--profile=<value> [default: default] User profile.
|
|
684
669
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
685
670
|
--type=<value> Type
|
|
686
671
|
|
|
687
|
-
GLOBAL FLAGS
|
|
688
|
-
--json Format output as json.
|
|
689
|
-
|
|
690
672
|
DESCRIPTION
|
|
691
673
|
List HALO credentials.
|
|
692
674
|
```
|
|
@@ -705,13 +687,11 @@ FLAGS
|
|
|
705
687
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
706
688
|
--dry-run Dry run.
|
|
707
689
|
--invitation=<value> Invitation code
|
|
690
|
+
--json Output as JSON.
|
|
708
691
|
--no-agent Auto-start agent.
|
|
709
692
|
--profile=<value> [default: default] User profile.
|
|
710
693
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
711
694
|
|
|
712
|
-
GLOBAL FLAGS
|
|
713
|
-
--json Format output as json.
|
|
714
|
-
|
|
715
695
|
DESCRIPTION
|
|
716
696
|
Join HALO (device) invitation.
|
|
717
697
|
```
|
|
@@ -759,7 +739,7 @@ DESCRIPTION
|
|
|
759
739
|
Display help for dx.
|
|
760
740
|
```
|
|
761
741
|
|
|
762
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.
|
|
742
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.14/src/commands/help.ts)_
|
|
763
743
|
|
|
764
744
|
## `dx kube auth`
|
|
765
745
|
|
|
@@ -800,14 +780,12 @@ FLAGS
|
|
|
800
780
|
--dev Deploy latest version from dev channel
|
|
801
781
|
--dry-run Dry run.
|
|
802
782
|
--hostname=<value> (required) Hostname
|
|
783
|
+
--json Output as JSON.
|
|
803
784
|
--no-agent Auto-start agent.
|
|
804
785
|
--profile=<value> [default: default] User profile.
|
|
805
786
|
--provider=<value> [default: digitalocean] Cloud Provider
|
|
806
787
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
807
788
|
|
|
808
|
-
GLOBAL FLAGS
|
|
809
|
-
--json Format output as json.
|
|
810
|
-
|
|
811
789
|
DESCRIPTION
|
|
812
790
|
Deploy KUBE.
|
|
813
791
|
```
|
|
@@ -818,11 +796,14 @@ List installed plugins.
|
|
|
818
796
|
|
|
819
797
|
```
|
|
820
798
|
USAGE
|
|
821
|
-
$ dx plugins [--core]
|
|
799
|
+
$ dx plugins [--json] [--core]
|
|
822
800
|
|
|
823
801
|
FLAGS
|
|
824
802
|
--core Show core plugins.
|
|
825
803
|
|
|
804
|
+
GLOBAL FLAGS
|
|
805
|
+
--json Format output as json.
|
|
806
|
+
|
|
826
807
|
DESCRIPTION
|
|
827
808
|
List installed plugins.
|
|
828
809
|
|
|
@@ -830,7 +811,7 @@ EXAMPLES
|
|
|
830
811
|
$ dx plugins
|
|
831
812
|
```
|
|
832
813
|
|
|
833
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
814
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/index.ts)_
|
|
834
815
|
|
|
835
816
|
## `dx plugins:install PLUGIN...`
|
|
836
817
|
|
|
@@ -1059,13 +1040,11 @@ FLAGS
|
|
|
1059
1040
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
1060
1041
|
--dry-run Dry run.
|
|
1061
1042
|
--force Force delete.
|
|
1043
|
+
--json Output as JSON.
|
|
1062
1044
|
--no-agent Auto-start agent.
|
|
1063
1045
|
--profile=<value> [default: default] User profile.
|
|
1064
1046
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1065
1047
|
|
|
1066
|
-
GLOBAL FLAGS
|
|
1067
|
-
--json Format output as json.
|
|
1068
|
-
|
|
1069
1048
|
DESCRIPTION
|
|
1070
1049
|
Reset user data.
|
|
1071
1050
|
```
|
|
@@ -1082,13 +1061,11 @@ FLAGS
|
|
|
1082
1061
|
-v, --verbose Verbose output
|
|
1083
1062
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
1084
1063
|
--dry-run Dry run.
|
|
1064
|
+
--json Output as JSON.
|
|
1085
1065
|
--no-agent Auto-start agent.
|
|
1086
1066
|
--profile=<value> [default: default] User profile.
|
|
1087
1067
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1088
1068
|
|
|
1089
|
-
GLOBAL FLAGS
|
|
1090
|
-
--json Format output as json.
|
|
1091
|
-
|
|
1092
1069
|
DESCRIPTION
|
|
1093
1070
|
Interactive shell.
|
|
1094
1071
|
```
|
|
@@ -1105,13 +1082,11 @@ FLAGS
|
|
|
1105
1082
|
-v, --verbose Verbose output
|
|
1106
1083
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
1107
1084
|
--dry-run Dry run.
|
|
1085
|
+
--json Output as JSON.
|
|
1108
1086
|
--no-agent Auto-start agent.
|
|
1109
1087
|
--profile=<value> [default: default] User profile.
|
|
1110
1088
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1111
1089
|
|
|
1112
|
-
GLOBAL FLAGS
|
|
1113
|
-
--json Format output as json.
|
|
1114
|
-
|
|
1115
1090
|
DESCRIPTION
|
|
1116
1091
|
List spaces.
|
|
1117
1092
|
```
|
|
@@ -1161,6 +1136,7 @@ FLAGS
|
|
|
1161
1136
|
--csv output is csv format [alias: --output=csv]
|
|
1162
1137
|
--dry-run Dry run.
|
|
1163
1138
|
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
1139
|
+
--json Output as JSON.
|
|
1164
1140
|
--no-agent Auto-start agent.
|
|
1165
1141
|
--no-header hide table header from output
|
|
1166
1142
|
--no-truncate do not truncate output to fit screen
|
|
@@ -1170,9 +1146,6 @@ FLAGS
|
|
|
1170
1146
|
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1171
1147
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1172
1148
|
|
|
1173
|
-
GLOBAL FLAGS
|
|
1174
|
-
--json Format output as json.
|
|
1175
|
-
|
|
1176
1149
|
DESCRIPTION
|
|
1177
1150
|
Create new epoch.
|
|
1178
1151
|
```
|
|
@@ -1190,13 +1163,11 @@ FLAGS
|
|
|
1190
1163
|
-v, --verbose Verbose output
|
|
1191
1164
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
1192
1165
|
--dry-run Dry run.
|
|
1166
|
+
--json Output as JSON.
|
|
1193
1167
|
--no-agent Auto-start agent.
|
|
1194
1168
|
--profile=<value> [default: default] User profile.
|
|
1195
1169
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1196
1170
|
|
|
1197
|
-
GLOBAL FLAGS
|
|
1198
|
-
--json Format output as json.
|
|
1199
|
-
|
|
1200
1171
|
DESCRIPTION
|
|
1201
1172
|
Create space invitation.
|
|
1202
1173
|
```
|
|
@@ -1215,14 +1186,12 @@ FLAGS
|
|
|
1215
1186
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
1216
1187
|
--dry-run Dry run.
|
|
1217
1188
|
--invitation=<value> Invitation code
|
|
1189
|
+
--json Output as JSON.
|
|
1218
1190
|
--no-agent Auto-start agent.
|
|
1219
1191
|
--profile=<value> [default: default] User profile.
|
|
1220
1192
|
--secret=<value> Invitation secret
|
|
1221
1193
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1222
1194
|
|
|
1223
|
-
GLOBAL FLAGS
|
|
1224
|
-
--json Format output as json.
|
|
1225
|
-
|
|
1226
1195
|
DESCRIPTION
|
|
1227
1196
|
Join space invitation
|
|
1228
1197
|
```
|
|
@@ -1245,6 +1214,7 @@ FLAGS
|
|
|
1245
1214
|
--csv output is csv format [alias: --output=csv]
|
|
1246
1215
|
--dry-run Dry run.
|
|
1247
1216
|
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
1217
|
+
--json Output as JSON.
|
|
1248
1218
|
--no-agent Auto-start agent.
|
|
1249
1219
|
--no-header hide table header from output
|
|
1250
1220
|
--no-truncate do not truncate output to fit screen
|
|
@@ -1254,9 +1224,6 @@ FLAGS
|
|
|
1254
1224
|
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1255
1225
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1256
1226
|
|
|
1257
|
-
GLOBAL FLAGS
|
|
1258
|
-
--json Format output as json.
|
|
1259
|
-
|
|
1260
1227
|
DESCRIPTION
|
|
1261
1228
|
List spaces.
|
|
1262
1229
|
```
|
|
@@ -1282,6 +1249,7 @@ FLAGS
|
|
|
1282
1249
|
--csv output is csv format [alias: --output=csv]
|
|
1283
1250
|
--dry-run Dry run.
|
|
1284
1251
|
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
1252
|
+
--json Output as JSON.
|
|
1285
1253
|
--no-agent Auto-start agent.
|
|
1286
1254
|
--no-header hide table header from output
|
|
1287
1255
|
--no-truncate do not truncate output to fit screen
|
|
@@ -1291,9 +1259,6 @@ FLAGS
|
|
|
1291
1259
|
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1292
1260
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1293
1261
|
|
|
1294
|
-
GLOBAL FLAGS
|
|
1295
|
-
--json Format output as json.
|
|
1296
|
-
|
|
1297
1262
|
DESCRIPTION
|
|
1298
1263
|
List space members.
|
|
1299
1264
|
```
|
|
@@ -1337,13 +1302,11 @@ FLAGS
|
|
|
1337
1302
|
--disabled Disable tunnel.
|
|
1338
1303
|
--dry-run Dry run.
|
|
1339
1304
|
--enabled Enable tunnel.
|
|
1305
|
+
--json Output as JSON.
|
|
1340
1306
|
--no-agent Auto-start agent.
|
|
1341
1307
|
--profile=<value> [default: default] User profile.
|
|
1342
1308
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1343
1309
|
|
|
1344
|
-
GLOBAL FLAGS
|
|
1345
|
-
--json Format output as json.
|
|
1346
|
-
|
|
1347
1310
|
DESCRIPTION
|
|
1348
1311
|
Enable or disable tunnel.
|
|
1349
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
|
-
*
|
|
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,
|
|
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"}
|