@dxos/cli 0.1.53-main.eeb434b → 0.1.53-main.f5aedb7

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 (11) hide show
  1. package/README.md +38 -10
  2. package/dist/src/commands/agent/list.d.ts.map +1 -1
  3. package/dist/src/commands/agent/list.js +3 -0
  4. package/dist/src/commands/agent/list.js.map +1 -1
  5. package/dist/src/commands/agent/restart.d.ts +10 -0
  6. package/dist/src/commands/agent/restart.d.ts.map +1 -1
  7. package/dist/src/commands/agent/restart.js +5 -0
  8. package/dist/src/commands/agent/restart.js.map +1 -1
  9. package/dist/src/util/telemetryrc.json +1 -1
  10. package/oclif.manifest.json +8 -3
  11. package/package.json +21 -21
package/README.md CHANGED
@@ -4,10 +4,43 @@ DXOS command line interface.
4
4
 
5
5
  <!-- toc -->
6
6
  * [DX CLI](#dx-cli)
7
+ * [Instalation](#instalation)
8
+ * [Running an Agent](#running-an-agent)
7
9
  * [Development](#development)
8
10
  * [Usage](#usage)
9
11
  <!-- tocstop -->
10
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
+
11
44
 
12
45
  # Development
13
46
 
@@ -31,11 +64,6 @@ Or source the following script to set the `dx` alias from any directory in the r
31
64
  dx config --json
32
65
  ```
33
66
 
34
- ## Resetting the CLI
35
-
36
- ```bash
37
- ```
38
-
39
67
  ## Reporting errors
40
68
 
41
69
  Run the following command to create a gist of the debug stats.
@@ -52,7 +80,7 @@ $ npm install -g @dxos/cli
52
80
  $ dx COMMAND
53
81
  running command...
54
82
  $ dx (--version)
55
- @dxos/cli/0.1.53-main.eeb434b linux-x64 node-v18.16.1
83
+ @dxos/cli/0.1.53-main.f5aedb7 linux-x64 node-v18.17.0
56
84
  $ dx --help [COMMAND]
57
85
  USAGE
58
86
  $ dx COMMAND
@@ -139,19 +167,19 @@ Restart agent daemon.
139
167
 
140
168
  ```
141
169
  USAGE
142
- $ 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]
143
172
 
144
173
  FLAGS
145
174
  -v, --verbose Verbose output
146
175
  --config=path [default: /home/runner/.config/dx/profile/default.yml] Config file.
147
176
  --dry-run Dry run.
177
+ --force Force restart.
178
+ --json Output as JSON.
148
179
  --no-agent Auto-start agent.
149
180
  --profile=<value> [default: default] User profile.
150
181
  --timeout=<value> [default: 30] Timeout in seconds.
151
182
 
152
- GLOBAL FLAGS
153
- --json Format output as json.
154
-
155
183
  DESCRIPTION
156
184
  Restart agent daemon.
157
185
  ```
package/dist/src/commands/agent/list.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../../src/commands/agent/list.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,eAAO,MAAM,WAAW,YAAa,GAAG,EAAE,qBAiCzC,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,WAAW,CAAC,OAAO,IAAI,CAAC;IACxD,OAAgB,cAAc,UAAQ;IACtC,OAAgB,WAAW,SAAkB;IAEvC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;CAS1B"}
1
+ {"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../../src/commands/agent/list.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,eAAO,MAAM,WAAW,YAAa,GAAG,EAAE,qBAoCzC,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,WAAW,CAAC,OAAO,IAAI,CAAC;IACxD,OAAgB,cAAc,UAAQ;IACtC,OAAgB,WAAW,SAAkB;IAEvC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;CAS1B"}
package/dist/src/commands/agent/list.js CHANGED
@@ -18,6 +18,9 @@ const printAgents = (daemons, flags = {}) => {
18
18
  running: {
19
19
  header: 'running',
20
20
  },
21
+ lockAcquired: {
22
+ header: 'lockAcquired',
23
+ },
21
24
  restarts: {
22
25
  header: 'restarts',
23
26
  },
package/dist/src/commands/agent/list.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../src/commands/agent/list.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;AAEF,sCAAiC;AACjC,uCAA0C;AAE1C,qDAAiD;AAE1C,MAAM,WAAW,GAAG,CAAC,OAAc,EAAE,KAAK,GAAG,EAAE,EAAE,EAAE;IACxD,SAAE,CAAC,KAAK,CACN,OAAO,EACP;QACE,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;SAClB;QACD,GAAG,EAAE;YACH,MAAM,EAAE,SAAS;SAClB;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;SAClB;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,UAAU;SACnB;QACD,MAAM,EAAE;YACN,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;gBACX,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE;oBAChB,OAAO,SAAS,CAAC;iBAClB;gBACD,OAAO,IAAA,yBAAc,EAAC,IAAI,IAAI,EAAE,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;YAC3D,CAAC;SACF;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;SAClB;KACF,EACD;QACE,GAAG,KAAK;KACT,CACF,CAAC;AACJ,CAAC,CAAC;AAjCW,QAAA,WAAW,eAiCtB;AAEF,MAAqB,IAAK,SAAQ,0BAAwB;IAIxD,KAAK,CAAC,GAAG;QACP,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAChD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;gBACpB,IAAA,mBAAW,EAAC,MAAM,CAAC,CAAC;aACrB;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;;AAXe,mBAAc,GAAG,IAAI,CAAC;AACtB,gBAAW,GAAG,cAAc,CAAC;kBAF1B,IAAI"}
1
+ {"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../src/commands/agent/list.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;AAEF,sCAAiC;AACjC,uCAA0C;AAE1C,qDAAiD;AAE1C,MAAM,WAAW,GAAG,CAAC,OAAc,EAAE,KAAK,GAAG,EAAE,EAAE,EAAE;IACxD,SAAE,CAAC,KAAK,CACN,OAAO,EACP;QACE,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;SAClB;QACD,GAAG,EAAE;YACH,MAAM,EAAE,SAAS;SAClB;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;SAClB;QACD,YAAY,EAAE;YACZ,MAAM,EAAE,cAAc;SACvB;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,UAAU;SACnB;QACD,MAAM,EAAE;YACN,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;gBACX,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE;oBAChB,OAAO,SAAS,CAAC;iBAClB;gBACD,OAAO,IAAA,yBAAc,EAAC,IAAI,IAAI,EAAE,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;YAC3D,CAAC;SACF;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;SAClB;KACF,EACD;QACE,GAAG,KAAK;KACT,CACF,CAAC;AACJ,CAAC,CAAC;AApCW,QAAA,WAAW,eAoCtB;AAEF,MAAqB,IAAK,SAAQ,0BAAwB;IAIxD,KAAK,CAAC,GAAG;QACP,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAChD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;gBACpB,IAAA,mBAAW,EAAC,MAAM,CAAC,CAAC;aACrB;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;;AAXe,mBAAc,GAAG,IAAI,CAAC;AACtB,gBAAW,GAAG,cAAc,CAAC;kBAF1B,IAAI"}
package/dist/src/commands/agent/restart.d.ts CHANGED
@@ -2,6 +2,16 @@ import { BaseCommand } from '../../base-command';
2
2
  export default class Restart extends BaseCommand<typeof Restart> {
3
3
  static enableJsonFlag: boolean;
4
4
  static description: string;
5
+ static flags: {
6
+ force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
7
+ json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
8
+ 'dry-run': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
9
+ verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
10
+ profile: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
11
+ config: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
12
+ 'no-agent': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
13
+ timeout: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
14
+ };
5
15
  run(): Promise<any>;
6
16
  }
7
17
  //# sourceMappingURL=restart.d.ts.map
package/dist/src/commands/agent/restart.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"restart.d.ts","sourceRoot":"","sources":["../../../../src/commands/agent/restart.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,WAAW,CAAC,OAAO,OAAO,CAAC;IAC9D,OAAgB,cAAc,UAAQ;IACtC,OAAgB,WAAW,SAA2B;IAEhD,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;CAQ1B"}
1
+ {"version":3,"file":"restart.d.ts","sourceRoot":"","sources":["../../../../src/commands/agent/restart.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,WAAW,CAAC,OAAO,OAAO,CAAC;IAC9D,OAAgB,cAAc,UAAQ;IACtC,OAAgB,WAAW,SAA2B;IAEtD,OAAgB,KAAK;;;;;;;;;MAGnB;IAEI,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;CAQ1B"}
package/dist/src/commands/agent/restart.js CHANGED
@@ -3,6 +3,7 @@
3
3
  // Copyright 2023 DXOS.org
4
4
  //
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
+ const core_1 = require("@oclif/core");
6
7
  const base_command_1 = require("../../base-command");
7
8
  class Restart extends base_command_1.BaseCommand {
8
9
  async run() {
@@ -16,5 +17,9 @@ class Restart extends base_command_1.BaseCommand {
16
17
  }
17
18
  Restart.enableJsonFlag = true;
18
19
  Restart.description = 'Restart agent daemon.';
20
+ Restart.flags = {
21
+ ...base_command_1.BaseCommand.flags,
22
+ force: core_1.Flags.boolean({ description: 'Force restart.' }),
23
+ };
19
24
  exports.default = Restart;
20
25
  //# sourceMappingURL=restart.js.map
package/dist/src/commands/agent/restart.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"restart.js","sourceRoot":"","sources":["../../../../src/commands/agent/restart.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;AAEF,qDAAiD;AAEjD,MAAqB,OAAQ,SAAQ,0BAA2B;IAI9D,KAAK,CAAC,GAAG;QACP,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAChD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YACxF,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;aAClC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;;AAVe,sBAAc,GAAG,IAAI,CAAC;AACtB,mBAAW,GAAG,uBAAuB,CAAC;kBAFnC,OAAO"}
1
+ {"version":3,"file":"restart.js","sourceRoot":"","sources":["../../../../src/commands/agent/restart.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;AAEF,sCAAoC;AAEpC,qDAAiD;AAEjD,MAAqB,OAAQ,SAAQ,0BAA2B;IAS9D,KAAK,CAAC,GAAG;QACP,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAChD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YACxF,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;aAClC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;;AAfe,sBAAc,GAAG,IAAI,CAAC;AACtB,mBAAW,GAAG,uBAAuB,CAAC;AAEtC,aAAK,GAAG;IACtB,GAAG,0BAAW,CAAC,KAAK;IACpB,KAAK,EAAE,YAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;CACxD,CAAC;kBAPiB,OAAO"}
package/dist/src/util/telemetryrc.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "DX_ENVIRONMENT": "staging",
3
- "DX_RELEASE": "@dxos/cli@0.1.53-main.eeb434b",
3
+ "DX_RELEASE": "@dxos/cli@0.1.53-main.f5aedb7",
4
4
  "SENTRY_DESTINATION": "https://2647916221e643869965e78469479aa4@o4504012000067584.ingest.sentry.io/4504012027265029",
5
5
  "TELEMETRY_API_KEY": "B00QG6PtJJrJ0VVFe0H5a6bcUUShKyZM",
6
6
  "IPDATA_API_KEY": "ccc5f0cd66dd34a7c31c2ddc61c2bbca2db73892a993982bb3a5f0e2"
package/oclif.manifest.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "0.1.53-main.eeb434b",
2
+ "version": "0.1.53-main.f5aedb7",
3
3
  "commands": {
4
4
  "agent:list": {
5
5
  "id": "agent:list",
@@ -82,8 +82,7 @@
82
82
  "json": {
83
83
  "name": "json",
84
84
  "type": "boolean",
85
- "description": "Format output as json.",
86
- "helpGroup": "GLOBAL",
85
+ "description": "Output as JSON.",
87
86
  "allowNo": false
88
87
  },
89
88
  "dry-run": {
@@ -135,6 +134,12 @@
135
134
  "aliases": [
136
135
  "t"
137
136
  ]
137
+ },
138
+ "force": {
139
+ "name": "force",
140
+ "type": "boolean",
141
+ "description": "Force restart.",
142
+ "allowNo": false
138
143
  }
139
144
  },
140
145
  "args": {}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/cli",
3
- "version": "0.1.53-main.eeb434b",
3
+ "version": "0.1.53-main.f5aedb7",
4
4
  "description": "DXOS CLI",
5
5
  "keywords": [
6
6
  "dxos",
@@ -47,26 +47,26 @@
47
47
  "tiny-invariant": "^1.3.1",
48
48
  "uuid": "^8.3.2",
49
49
  "ws": "^7.4.4",
50
- "@dxos/agent": "0.1.53-main.eeb434b",
51
- "@dxos/async": "0.1.53-main.eeb434b",
52
- "@dxos/bare-template": "0.1.53-main.eeb434b",
53
- "@dxos/client": "0.1.53-main.eeb434b",
54
- "@dxos/client-protocol": "0.1.53-main.eeb434b",
55
- "@dxos/codec-protobuf": "0.1.53-main.eeb434b",
56
- "@dxos/config": "0.1.53-main.eeb434b",
57
- "@dxos/context": "0.1.53-main.eeb434b",
58
- "@dxos/functions": "0.1.53-main.eeb434b",
59
- "@dxos/debug": "0.1.53-main.eeb434b",
60
- "@dxos/hello-template": "0.1.53-main.eeb434b",
61
- "@dxos/log": "0.1.53-main.eeb434b",
62
- "@dxos/protocols": "0.1.53-main.eeb434b",
63
- "@dxos/plate": "0.1.53-main.eeb434b",
64
- "@dxos/rpc": "0.1.53-main.eeb434b",
65
- "@dxos/sentry": "0.1.53-main.eeb434b",
66
- "@dxos/tasks-template": "0.1.53-main.eeb434b",
67
- "@dxos/telemetry": "0.1.53-main.eeb434b",
68
- "@dxos/util": "0.1.53-main.eeb434b",
69
- "@dxos/websocket-rpc": "0.1.53-main.eeb434b"
50
+ "@dxos/agent": "0.1.53-main.f5aedb7",
51
+ "@dxos/async": "0.1.53-main.f5aedb7",
52
+ "@dxos/bare-template": "0.1.53-main.f5aedb7",
53
+ "@dxos/client": "0.1.53-main.f5aedb7",
54
+ "@dxos/client-protocol": "0.1.53-main.f5aedb7",
55
+ "@dxos/codec-protobuf": "0.1.53-main.f5aedb7",
56
+ "@dxos/config": "0.1.53-main.f5aedb7",
57
+ "@dxos/context": "0.1.53-main.f5aedb7",
58
+ "@dxos/debug": "0.1.53-main.f5aedb7",
59
+ "@dxos/functions": "0.1.53-main.f5aedb7",
60
+ "@dxos/hello-template": "0.1.53-main.f5aedb7",
61
+ "@dxos/log": "0.1.53-main.f5aedb7",
62
+ "@dxos/plate": "0.1.53-main.f5aedb7",
63
+ "@dxos/protocols": "0.1.53-main.f5aedb7",
64
+ "@dxos/rpc": "0.1.53-main.f5aedb7",
65
+ "@dxos/sentry": "0.1.53-main.f5aedb7",
66
+ "@dxos/tasks-template": "0.1.53-main.f5aedb7",
67
+ "@dxos/telemetry": "0.1.53-main.f5aedb7",
68
+ "@dxos/util": "0.1.53-main.f5aedb7",
69
+ "@dxos/websocket-rpc": "0.1.53-main.f5aedb7"
70
70
  },
71
71
  "devDependencies": {
72
72
  "@oclif/test": "^2.3.31",