@dxos/cli 0.1.52 → 0.1.53-main.01c99c0
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 +140 -79
- package/dist/src/base-command.d.ts +12 -9
- package/dist/src/base-command.d.ts.map +1 -1
- package/dist/src/base-command.js +27 -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 +31 -20
- 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 +4 -4
- 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 +2 -1
- package/dist/src/commands/debug/stats.d.ts.map +1 -1
- package/dist/src/commands/debug/stats.js +28 -1
- package/dist/src/commands/debug/stats.js.map +1 -1
- package/dist/src/commands/device/index.d.ts.map +1 -1
- package/dist/src/commands/device/index.js +4 -0
- package/dist/src/commands/device/index.js.map +1 -1
- package/dist/src/commands/function/{dev.d.ts → dev-server.d.ts} +9 -2
- package/dist/src/commands/function/dev-server.d.ts.map +1 -0
- package/dist/src/commands/function/dev-server.js +69 -0
- package/dist/src/commands/function/dev-server.js.map +1 -0
- package/dist/src/commands/function/exec.d.ts +4 -0
- package/dist/src/commands/function/exec.d.ts.map +1 -1
- package/dist/src/commands/function/exec.js +4 -0
- package/dist/src/commands/function/exec.js.map +1 -1
- package/dist/src/commands/function/list.d.ts +4 -0
- package/dist/src/commands/function/list.d.ts.map +1 -1
- package/dist/src/commands/function/list.js +4 -0
- package/dist/src/commands/function/list.js.map +1 -1
- package/dist/src/commands/function/logs.d.ts +4 -0
- package/dist/src/commands/function/logs.d.ts.map +1 -1
- package/dist/src/commands/function/logs.js +4 -0
- package/dist/src/commands/function/logs.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 +8 -5
- 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 +2 -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/epoch.js +1 -0
- package/dist/src/commands/space/epoch.js.map +1 -1
- package/dist/src/commands/space/invite.d.ts.map +1 -1
- package/dist/src/commands/space/invite.js +4 -4
- 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 +3 -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/list.js +1 -0
- package/dist/src/commands/space/list.js.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/space/members.js +1 -0
- package/dist/src/commands/space/members.js.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/dist/src/util/util.js +1 -0
- package/dist/src/util/util.js.map +1 -1
- package/oclif.manifest.json +58 -48
- package/package.json +31 -32
- package/dist/src/commands/function/dev.d.ts.map +0 -1
- package/dist/src/commands/function/dev.js +0 -33
- package/dist/src/commands/function/dev.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:
|
|
10
48
|
|
|
11
49
|
```bash
|
|
12
|
-
|
|
50
|
+
nx run cli:build --watch=true
|
|
13
51
|
```
|
|
14
52
|
|
|
15
|
-
Run the CLI
|
|
53
|
+
Run the CLI from the local directory:
|
|
16
54
|
|
|
17
55
|
```bash
|
|
18
|
-
|
|
19
|
-
|
|
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.
|
|
83
|
+
@dxos/cli/0.1.53-main.01c99c0 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)
|
|
@@ -51,6 +104,7 @@ USAGE
|
|
|
51
104
|
* [`dx device`](#dx-device)
|
|
52
105
|
* [`dx device list`](#dx-device-list)
|
|
53
106
|
* [`dx function dev`](#dx-function-dev)
|
|
107
|
+
* [`dx function dev-server`](#dx-function-dev-server)
|
|
54
108
|
* [`dx function exec NAME`](#dx-function-exec-name)
|
|
55
109
|
* [`dx function list`](#dx-function-list)
|
|
56
110
|
* [`dx function logs NAME`](#dx-function-logs-name)
|
|
@@ -113,19 +167,19 @@ Restart agent daemon.
|
|
|
113
167
|
|
|
114
168
|
```
|
|
115
169
|
USAGE
|
|
116
|
-
$ 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]
|
|
117
172
|
|
|
118
173
|
FLAGS
|
|
119
174
|
-v, --verbose Verbose output
|
|
120
175
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
121
176
|
--dry-run Dry run.
|
|
177
|
+
--force Force restart.
|
|
178
|
+
--json Output as JSON.
|
|
122
179
|
--no-agent Auto-start agent.
|
|
123
180
|
--profile=<value> [default: default] User profile.
|
|
124
181
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
125
182
|
|
|
126
|
-
GLOBAL FLAGS
|
|
127
|
-
--json Format output as json.
|
|
128
|
-
|
|
129
183
|
DESCRIPTION
|
|
130
184
|
Restart agent daemon.
|
|
131
185
|
```
|
|
@@ -145,15 +199,13 @@ FLAGS
|
|
|
145
199
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
146
200
|
--dry-run Dry run.
|
|
147
201
|
--echo=port Expose ECHO REST API.
|
|
202
|
+
--json Output as JSON.
|
|
148
203
|
--monitor Run epoch monitoring.
|
|
149
204
|
--no-agent Auto-start agent.
|
|
150
205
|
--profile=<value> [default: default] User profile.
|
|
151
206
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
152
207
|
--web-socket=port Expose web socket port.
|
|
153
208
|
|
|
154
|
-
GLOBAL FLAGS
|
|
155
|
-
--json Format output as json.
|
|
156
|
-
|
|
157
209
|
DESCRIPTION
|
|
158
210
|
Starts the agent.
|
|
159
211
|
```
|
|
@@ -165,20 +217,19 @@ Stop agent daemon.
|
|
|
165
217
|
```
|
|
166
218
|
USAGE
|
|
167
219
|
$ dx agent stop [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
|
|
168
|
-
<value>] [
|
|
220
|
+
<value>] [--all] [--force]
|
|
169
221
|
|
|
170
222
|
FLAGS
|
|
171
|
-
-a, --all Stop all agents.
|
|
172
223
|
-v, --verbose Verbose output
|
|
224
|
+
--all Stop all agents.
|
|
173
225
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
174
226
|
--dry-run Dry run.
|
|
227
|
+
--force Force stop.
|
|
228
|
+
--json Output as JSON.
|
|
175
229
|
--no-agent Auto-start agent.
|
|
176
230
|
--profile=<value> [default: default] User profile.
|
|
177
231
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
178
232
|
|
|
179
|
-
GLOBAL FLAGS
|
|
180
|
-
--json Format output as json.
|
|
181
|
-
|
|
182
233
|
DESCRIPTION
|
|
183
234
|
Stop agent daemon.
|
|
184
235
|
```
|
|
@@ -202,14 +253,12 @@ FLAGS
|
|
|
202
253
|
-v, --verbose Verbose output
|
|
203
254
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
204
255
|
--dry-run Dry run.
|
|
256
|
+
--json Output as JSON.
|
|
205
257
|
--no-agent Auto-start agent.
|
|
206
258
|
--profile=<value> [default: default] User profile.
|
|
207
259
|
--tag=<value> Git tag or branch of the DXOS repo to checkout.
|
|
208
260
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
209
261
|
|
|
210
|
-
GLOBAL FLAGS
|
|
211
|
-
--json Format output as json.
|
|
212
|
-
|
|
213
262
|
DESCRIPTION
|
|
214
263
|
Manage applications.
|
|
215
264
|
```
|
|
@@ -281,15 +330,13 @@ FLAGS
|
|
|
281
330
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
282
331
|
--configPath=<value> Path to dx.yml
|
|
283
332
|
--dry-run Dry run.
|
|
333
|
+
--json Output as JSON.
|
|
284
334
|
--no-agent Auto-start agent.
|
|
285
335
|
--profile=<value> [default: default] User profile.
|
|
286
336
|
--skipExisting Do not update content on KUBE if version already exists.
|
|
287
337
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
288
338
|
--version=<value> Version of modules to publish.
|
|
289
339
|
|
|
290
|
-
GLOBAL FLAGS
|
|
291
|
-
--json Format output as json.
|
|
292
|
-
|
|
293
340
|
DESCRIPTION
|
|
294
341
|
Publish apps.
|
|
295
342
|
```
|
|
@@ -323,21 +370,19 @@ Output debug stats.
|
|
|
323
370
|
|
|
324
371
|
```
|
|
325
372
|
USAGE
|
|
326
|
-
$ dx debug stats [--json] [--dry-run] [
|
|
373
|
+
$ dx debug stats [--json] [--dry-run] [--verbose] [--config <value> --profile <value>] [--no-agent] [--timeout
|
|
327
374
|
<value>] [--humanize] [--truncate]
|
|
328
375
|
|
|
329
376
|
FLAGS
|
|
330
|
-
-v, --verbose Verbose output
|
|
331
377
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
332
378
|
--dry-run Dry run.
|
|
333
379
|
--humanize Humanized keys.
|
|
380
|
+
--json Output as JSON.
|
|
334
381
|
--no-agent Auto-start agent.
|
|
335
382
|
--profile=<value> [default: default] User profile.
|
|
336
383
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
337
384
|
--truncate Truncate keys.
|
|
338
|
-
|
|
339
|
-
GLOBAL FLAGS
|
|
340
|
-
--json Format output as json.
|
|
385
|
+
--verbose Verbose output.
|
|
341
386
|
|
|
342
387
|
DESCRIPTION
|
|
343
388
|
Output debug stats.
|
|
@@ -391,27 +436,66 @@ DESCRIPTION
|
|
|
391
436
|
|
|
392
437
|
## `dx function dev`
|
|
393
438
|
|
|
394
|
-
|
|
439
|
+
Development server.
|
|
395
440
|
|
|
396
441
|
```
|
|
397
442
|
USAGE
|
|
398
443
|
$ dx function dev [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
|
|
399
|
-
<value>] [--require <value>]
|
|
444
|
+
<value>] [--require <value>] [--manifest <value>]
|
|
400
445
|
|
|
401
446
|
FLAGS
|
|
402
447
|
-v, --verbose Verbose output
|
|
403
448
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
404
449
|
--dry-run Dry run.
|
|
450
|
+
--json Output as JSON.
|
|
451
|
+
--manifest=<value> [default: functions.yml]
|
|
405
452
|
--no-agent Auto-start agent.
|
|
406
453
|
--profile=<value> [default: default] User profile.
|
|
407
|
-
--require=<value>...
|
|
454
|
+
--require=<value>... [default: ts-node/register]
|
|
408
455
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
409
456
|
|
|
410
|
-
|
|
411
|
-
|
|
457
|
+
DESCRIPTION
|
|
458
|
+
Development server.
|
|
459
|
+
|
|
460
|
+
ALIASES
|
|
461
|
+
$ dx function dev
|
|
462
|
+
|
|
463
|
+
EXAMPLES
|
|
464
|
+
Run with TypeScript support.
|
|
465
|
+
|
|
466
|
+
$ dx function dev-server -r ts-node/register --verbose
|
|
467
|
+
```
|
|
468
|
+
|
|
469
|
+
## `dx function dev-server`
|
|
470
|
+
|
|
471
|
+
Development server.
|
|
472
|
+
|
|
473
|
+
```
|
|
474
|
+
USAGE
|
|
475
|
+
$ dx function dev-server [--json] [--dry-run] [-v] [--config <value> --profile <value>] [--no-agent] [--timeout
|
|
476
|
+
<value>] [--require <value>] [--manifest <value>]
|
|
477
|
+
|
|
478
|
+
FLAGS
|
|
479
|
+
-v, --verbose Verbose output
|
|
480
|
+
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
481
|
+
--dry-run Dry run.
|
|
482
|
+
--json Output as JSON.
|
|
483
|
+
--manifest=<value> [default: functions.yml]
|
|
484
|
+
--no-agent Auto-start agent.
|
|
485
|
+
--profile=<value> [default: default] User profile.
|
|
486
|
+
--require=<value>... [default: ts-node/register]
|
|
487
|
+
--timeout=<value> [default: 30] Timeout in seconds.
|
|
412
488
|
|
|
413
489
|
DESCRIPTION
|
|
414
|
-
|
|
490
|
+
Development server.
|
|
491
|
+
|
|
492
|
+
ALIASES
|
|
493
|
+
$ dx function dev
|
|
494
|
+
|
|
495
|
+
EXAMPLES
|
|
496
|
+
Run with TypeScript support.
|
|
497
|
+
|
|
498
|
+
$ dx function dev-server -r ts-node/register --verbose
|
|
415
499
|
```
|
|
416
500
|
|
|
417
501
|
## `dx function exec NAME`
|
|
@@ -557,13 +641,11 @@ FLAGS
|
|
|
557
641
|
-v, --verbose Verbose output
|
|
558
642
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
559
643
|
--dry-run Dry run.
|
|
644
|
+
--json Output as JSON.
|
|
560
645
|
--no-agent Auto-start agent.
|
|
561
646
|
--profile=<value> [default: default] User profile.
|
|
562
647
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
563
648
|
|
|
564
|
-
GLOBAL FLAGS
|
|
565
|
-
--json Format output as json.
|
|
566
|
-
|
|
567
649
|
DESCRIPTION
|
|
568
650
|
Import credential into HALO.
|
|
569
651
|
```
|
|
@@ -581,14 +663,12 @@ FLAGS
|
|
|
581
663
|
-v, --verbose Verbose output
|
|
582
664
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
583
665
|
--dry-run Dry run.
|
|
666
|
+
--json Output as JSON.
|
|
584
667
|
--no-agent Auto-start agent.
|
|
585
668
|
--profile=<value> [default: default] User profile.
|
|
586
669
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
587
670
|
--type=<value> Type
|
|
588
671
|
|
|
589
|
-
GLOBAL FLAGS
|
|
590
|
-
--json Format output as json.
|
|
591
|
-
|
|
592
672
|
DESCRIPTION
|
|
593
673
|
List HALO credentials.
|
|
594
674
|
```
|
|
@@ -607,13 +687,11 @@ FLAGS
|
|
|
607
687
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
608
688
|
--dry-run Dry run.
|
|
609
689
|
--invitation=<value> Invitation code
|
|
690
|
+
--json Output as JSON.
|
|
610
691
|
--no-agent Auto-start agent.
|
|
611
692
|
--profile=<value> [default: default] User profile.
|
|
612
693
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
613
694
|
|
|
614
|
-
GLOBAL FLAGS
|
|
615
|
-
--json Format output as json.
|
|
616
|
-
|
|
617
695
|
DESCRIPTION
|
|
618
696
|
Join HALO (device) invitation.
|
|
619
697
|
```
|
|
@@ -661,7 +739,7 @@ DESCRIPTION
|
|
|
661
739
|
Display help for dx.
|
|
662
740
|
```
|
|
663
741
|
|
|
664
|
-
_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)_
|
|
665
743
|
|
|
666
744
|
## `dx kube auth`
|
|
667
745
|
|
|
@@ -702,14 +780,12 @@ FLAGS
|
|
|
702
780
|
--dev Deploy latest version from dev channel
|
|
703
781
|
--dry-run Dry run.
|
|
704
782
|
--hostname=<value> (required) Hostname
|
|
783
|
+
--json Output as JSON.
|
|
705
784
|
--no-agent Auto-start agent.
|
|
706
785
|
--profile=<value> [default: default] User profile.
|
|
707
786
|
--provider=<value> [default: digitalocean] Cloud Provider
|
|
708
787
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
709
788
|
|
|
710
|
-
GLOBAL FLAGS
|
|
711
|
-
--json Format output as json.
|
|
712
|
-
|
|
713
789
|
DESCRIPTION
|
|
714
790
|
Deploy KUBE.
|
|
715
791
|
```
|
|
@@ -720,11 +796,14 @@ List installed plugins.
|
|
|
720
796
|
|
|
721
797
|
```
|
|
722
798
|
USAGE
|
|
723
|
-
$ dx plugins [--core]
|
|
799
|
+
$ dx plugins [--json] [--core]
|
|
724
800
|
|
|
725
801
|
FLAGS
|
|
726
802
|
--core Show core plugins.
|
|
727
803
|
|
|
804
|
+
GLOBAL FLAGS
|
|
805
|
+
--json Format output as json.
|
|
806
|
+
|
|
728
807
|
DESCRIPTION
|
|
729
808
|
List installed plugins.
|
|
730
809
|
|
|
@@ -732,7 +811,7 @@ EXAMPLES
|
|
|
732
811
|
$ dx plugins
|
|
733
812
|
```
|
|
734
813
|
|
|
735
|
-
_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)_
|
|
736
815
|
|
|
737
816
|
## `dx plugins:install PLUGIN...`
|
|
738
817
|
|
|
@@ -961,13 +1040,11 @@ FLAGS
|
|
|
961
1040
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
962
1041
|
--dry-run Dry run.
|
|
963
1042
|
--force Force delete.
|
|
1043
|
+
--json Output as JSON.
|
|
964
1044
|
--no-agent Auto-start agent.
|
|
965
1045
|
--profile=<value> [default: default] User profile.
|
|
966
1046
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
967
1047
|
|
|
968
|
-
GLOBAL FLAGS
|
|
969
|
-
--json Format output as json.
|
|
970
|
-
|
|
971
1048
|
DESCRIPTION
|
|
972
1049
|
Reset user data.
|
|
973
1050
|
```
|
|
@@ -984,13 +1061,11 @@ FLAGS
|
|
|
984
1061
|
-v, --verbose Verbose output
|
|
985
1062
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
986
1063
|
--dry-run Dry run.
|
|
1064
|
+
--json Output as JSON.
|
|
987
1065
|
--no-agent Auto-start agent.
|
|
988
1066
|
--profile=<value> [default: default] User profile.
|
|
989
1067
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
990
1068
|
|
|
991
|
-
GLOBAL FLAGS
|
|
992
|
-
--json Format output as json.
|
|
993
|
-
|
|
994
1069
|
DESCRIPTION
|
|
995
1070
|
Interactive shell.
|
|
996
1071
|
```
|
|
@@ -1007,13 +1082,11 @@ FLAGS
|
|
|
1007
1082
|
-v, --verbose Verbose output
|
|
1008
1083
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
1009
1084
|
--dry-run Dry run.
|
|
1085
|
+
--json Output as JSON.
|
|
1010
1086
|
--no-agent Auto-start agent.
|
|
1011
1087
|
--profile=<value> [default: default] User profile.
|
|
1012
1088
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1013
1089
|
|
|
1014
|
-
GLOBAL FLAGS
|
|
1015
|
-
--json Format output as json.
|
|
1016
|
-
|
|
1017
1090
|
DESCRIPTION
|
|
1018
1091
|
List spaces.
|
|
1019
1092
|
```
|
|
@@ -1063,6 +1136,7 @@ FLAGS
|
|
|
1063
1136
|
--csv output is csv format [alias: --output=csv]
|
|
1064
1137
|
--dry-run Dry run.
|
|
1065
1138
|
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
1139
|
+
--json Output as JSON.
|
|
1066
1140
|
--no-agent Auto-start agent.
|
|
1067
1141
|
--no-header hide table header from output
|
|
1068
1142
|
--no-truncate do not truncate output to fit screen
|
|
@@ -1072,9 +1146,6 @@ FLAGS
|
|
|
1072
1146
|
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1073
1147
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1074
1148
|
|
|
1075
|
-
GLOBAL FLAGS
|
|
1076
|
-
--json Format output as json.
|
|
1077
|
-
|
|
1078
1149
|
DESCRIPTION
|
|
1079
1150
|
Create new epoch.
|
|
1080
1151
|
```
|
|
@@ -1092,13 +1163,11 @@ FLAGS
|
|
|
1092
1163
|
-v, --verbose Verbose output
|
|
1093
1164
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
1094
1165
|
--dry-run Dry run.
|
|
1166
|
+
--json Output as JSON.
|
|
1095
1167
|
--no-agent Auto-start agent.
|
|
1096
1168
|
--profile=<value> [default: default] User profile.
|
|
1097
1169
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1098
1170
|
|
|
1099
|
-
GLOBAL FLAGS
|
|
1100
|
-
--json Format output as json.
|
|
1101
|
-
|
|
1102
1171
|
DESCRIPTION
|
|
1103
1172
|
Create space invitation.
|
|
1104
1173
|
```
|
|
@@ -1117,14 +1186,12 @@ FLAGS
|
|
|
1117
1186
|
--config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
|
|
1118
1187
|
--dry-run Dry run.
|
|
1119
1188
|
--invitation=<value> Invitation code
|
|
1189
|
+
--json Output as JSON.
|
|
1120
1190
|
--no-agent Auto-start agent.
|
|
1121
1191
|
--profile=<value> [default: default] User profile.
|
|
1122
1192
|
--secret=<value> Invitation secret
|
|
1123
1193
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1124
1194
|
|
|
1125
|
-
GLOBAL FLAGS
|
|
1126
|
-
--json Format output as json.
|
|
1127
|
-
|
|
1128
1195
|
DESCRIPTION
|
|
1129
1196
|
Join space invitation
|
|
1130
1197
|
```
|
|
@@ -1147,6 +1214,7 @@ FLAGS
|
|
|
1147
1214
|
--csv output is csv format [alias: --output=csv]
|
|
1148
1215
|
--dry-run Dry run.
|
|
1149
1216
|
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
1217
|
+
--json Output as JSON.
|
|
1150
1218
|
--no-agent Auto-start agent.
|
|
1151
1219
|
--no-header hide table header from output
|
|
1152
1220
|
--no-truncate do not truncate output to fit screen
|
|
@@ -1156,9 +1224,6 @@ FLAGS
|
|
|
1156
1224
|
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1157
1225
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1158
1226
|
|
|
1159
|
-
GLOBAL FLAGS
|
|
1160
|
-
--json Format output as json.
|
|
1161
|
-
|
|
1162
1227
|
DESCRIPTION
|
|
1163
1228
|
List spaces.
|
|
1164
1229
|
```
|
|
@@ -1184,6 +1249,7 @@ FLAGS
|
|
|
1184
1249
|
--csv output is csv format [alias: --output=csv]
|
|
1185
1250
|
--dry-run Dry run.
|
|
1186
1251
|
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
1252
|
+
--json Output as JSON.
|
|
1187
1253
|
--no-agent Auto-start agent.
|
|
1188
1254
|
--no-header hide table header from output
|
|
1189
1255
|
--no-truncate do not truncate output to fit screen
|
|
@@ -1193,9 +1259,6 @@ FLAGS
|
|
|
1193
1259
|
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1194
1260
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1195
1261
|
|
|
1196
|
-
GLOBAL FLAGS
|
|
1197
|
-
--json Format output as json.
|
|
1198
|
-
|
|
1199
1262
|
DESCRIPTION
|
|
1200
1263
|
List space members.
|
|
1201
1264
|
```
|
|
@@ -1239,13 +1302,11 @@ FLAGS
|
|
|
1239
1302
|
--disabled Disable tunnel.
|
|
1240
1303
|
--dry-run Dry run.
|
|
1241
1304
|
--enabled Enable tunnel.
|
|
1305
|
+
--json Output as JSON.
|
|
1242
1306
|
--no-agent Auto-start agent.
|
|
1243
1307
|
--profile=<value> [default: default] User profile.
|
|
1244
1308
|
--timeout=<value> [default: 30] Timeout in seconds.
|
|
1245
1309
|
|
|
1246
|
-
GLOBAL FLAGS
|
|
1247
|
-
--json Format output as json.
|
|
1248
|
-
|
|
1249
1310
|
DESCRIPTION
|
|
1250
1311
|
Enable or disable tunnel.
|
|
1251
1312
|
```
|
|
@@ -7,19 +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
|
-
private _clientConfig?;
|
|
14
|
-
private _client?;
|
|
15
|
-
protected _startTime: Date;
|
|
16
|
-
private _failing;
|
|
17
|
-
private readonly _stdin?;
|
|
18
|
-
protected flags: Flags<T>;
|
|
19
|
-
protected args: Args<T>;
|
|
20
|
-
protected _telemetryContext?: TelemetryContext;
|
|
21
13
|
static enableJsonFlag: boolean;
|
|
22
14
|
static flags: {
|
|
15
|
+
json: Interfaces.BooleanFlag<boolean>;
|
|
23
16
|
'dry-run': Interfaces.BooleanFlag<boolean>;
|
|
24
17
|
verbose: Interfaces.BooleanFlag<boolean>;
|
|
25
18
|
profile: Interfaces.OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
@@ -27,9 +20,18 @@ export declare abstract class BaseCommand<T extends typeof Command = any> extend
|
|
|
27
20
|
'no-agent': Interfaces.BooleanFlag<boolean>;
|
|
28
21
|
timeout: Interfaces.OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
29
22
|
};
|
|
23
|
+
private readonly _stdin?;
|
|
24
|
+
private _clientConfig?;
|
|
25
|
+
private _client?;
|
|
26
|
+
private _startTime;
|
|
27
|
+
private _failing;
|
|
28
|
+
protected _telemetryContext?: TelemetryContext;
|
|
29
|
+
protected flags: Flags<T>;
|
|
30
|
+
protected args: Args<T>;
|
|
30
31
|
constructor(argv: string[], config: OclifConfig);
|
|
31
32
|
get clientConfig(): Config;
|
|
32
33
|
get stdin(): string | undefined;
|
|
34
|
+
get duration(): number;
|
|
33
35
|
done(): void;
|
|
34
36
|
/**
|
|
35
37
|
* Load the client config.
|
|
@@ -54,6 +56,7 @@ export declare abstract class BaseCommand<T extends typeof Command = any> extend
|
|
|
54
56
|
* https://oclif.io/docs/error_handling
|
|
55
57
|
*/
|
|
56
58
|
error(err: string | Error, options?: any): never;
|
|
59
|
+
catch(err: Error, options?: any): Promise<void>;
|
|
57
60
|
/**
|
|
58
61
|
* Called after each command run.
|
|
59
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"}
|