@dxos/cli 0.1.48 → 0.1.49-next.c888fc1

package/bin/dev

@@ -1,17 +1,18 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --no-warnings
+// NOTE: Specify --no-warnings in production script.
 
 const oclif = require('@oclif/core')
 
 const path = require('path')
 const project = path.join(__dirname, '..', 'tsconfig.json')
 
-// In dev mode -> use ts-node and dev plugins
+// In dev mode -> use ts-node and dev plugins.
 process.env.NODE_ENV = 'development'
 
 require('ts-node').register({project})
 
-// In dev mode, always show stack traces
+// In dev mode, always show stack traces.
 oclif.settings.debug = true;
 
-// Start the CLI
+// Start the CLI.
 oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -1,3 +1,3 @@
 @echo off
 
-node "%~dp0\dev" %*
+node "%~dp0\dev" %*

package/bin/run

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --no-warnings
 
 const oclif = require('@oclif/core')
 

package/config/config-default.yml

@@ -4,25 +4,23 @@ runtime:
   client:
     storage:
       persistent: true
-      path: '/tmp/dx/cli'
+      path: /tmp/dx/run
 
   services:
     ipfs:
-      server: "http://kube.dxos.org:5001/"
-      gateway: "http://kube.dxos.org:8888/ipfs"
+      server: http://kube.dxos.org:5001/
+      gateway: http://kube.dxos.org:8888/ipfs
     signaling:
-      - server: 'wss://dev.kube.dxos.org/.well-known/dx/signal'
-      - server: 'wss://kube.dxos.org/.well-known/dx/signal'
+      - server: wss://dev.kube.dxos.org/.well-known/dx/signal
+      - server: wss://kube.dxos.org/.well-known/dx/signal
     ice:
-      - urls: 'stun:kube.dxos.org:3478'
-      - urls: 'turn:kube.dxos.org:3478'
-        username: 'dxos'
-        credential: 'dxos'
+      - urls: stun:kube.dxos.org:3478
+      - urls: turn:kube.dxos.org:3478
+        username: dxos
+        credential: dxos
     publisher:
       server: ws://127.0.0.1/.well-known/dx/deploy
     supervisor:
       server: ws://127.0.0.1/.well-known/dx/supervisor
     tunneling:
       server: ws://127.0.0.1/.well-known/dx/tunnel
-    machine:
-      doAccessToken: ''

package/config/config-dev.yml

@@ -4,22 +4,22 @@ runtime:
   client:
     storage:
       persistent: true
-      path: '/tmp/dx/cli'
+      path: /tmp/dx/run
 
   services:
     ipfs:
-      server: "http://dx.dev.kube.dxos.org:5001/"
-      gateway: "http://dx.dev.kube.dxos.org:8888/ipfs"
+      server: http://dx.dev.kube.dxos.org:5001/
+      gateway: http://dx.dev.kube.dxos.org:8888/ipfs
     signaling:
-      - server: 'wss://dx.dev.kube.dxos.org/.well-known/dx/signal'
-      - server: 'wss://staging.kube.dxos.org/.well-known/dx/signal'
+      - server: wss://dx.dev.kube.dxos.org/.well-known/dx/signal
+      - server: wss://staging.kube.dxos.org/.well-known/dx/signal
     ice:
-      - urls: 'stun:dx.dev.kube.dxos.org:3478'
-      - urls: 'turn:dx.dev.kube.dxos.org:3478'
-        username: 'dxos'
-        credential: 'dxos'
+      - urls: stun:dx.dev.kube.dxos.org:3478
+      - urls: turn:dx.dev.kube.dxos.org:3478
+        username: dxos
+        credential: dxos
     publisher:
-      server: 'wss://dx.dev.kube.dxos.org/.well-known/dx/deploy'
+      server: wss://dx.dev.kube.dxos.org/.well-known/dx/deploy
     supervisor:
       server: wss://dx.dev.kube.dxos.org/.well-known/dx/supervisor
     tunneling:

package/config/config-local.yml

@@ -4,7 +4,7 @@ runtime:
   client:
     storage:
       persistent: true
-      path: /tmp/dx/cli
+      path: /tmp/dx/run
 
 
   services:
@@ -32,4 +32,4 @@ runtime:
     tunneling:
       server: wss://127.0.0.1/.well-known/dx/tunnel
     machine:
-      doAccessToken: ''
+      doAccessToken:

package/config/config-staging.yml

@@ -4,22 +4,22 @@ runtime:
   client:
     storage:
       persistent: true
-      path: '/tmp/dx/cli'
+      path: /tmp/dx/run
 
   services:
     ipfs:
-      server: "http://staging.kube.dxos.org:5001/"
-      gateway: "http://staging.kube.dxos.org:8888/ipfs"
+      server: http://staging.kube.dxos.org:5001/
+      gateway: http://staging.kube.dxos.org:8888/ipfs
     signaling:
-      - server: 'wss://staging.kube.dxos.org/.well-known/dx/signal'
-      - server: 'wss://dx.dev.kube.dxos.org/.well-known/dx/signal'
+      - server: wss://staging.kube.dxos.org/.well-known/dx/signal
+      - server: wss://dx.dev.kube.dxos.org/.well-known/dx/signal
     ice:
-      - urls: 'stun:staging.kube.dxos.org:3478'
-      - urls: 'turn:staging.kube.dxos.org:3478'
-        username: 'dxos'
-        credential: 'dxos'
+      - urls: stun:staging.kube.dxos.org:3478
+      - urls: turn:staging.kube.dxos.org:3478
+        username: dxos
+        credential: dxos
     publisher:
-      server: 'wss://staging.kube.dxos.org/.well-known/dx/deploy'
+      server: wss://staging.kube.dxos.org/.well-known/dx/deploy
     supervisor:
       server: wss://staging.kube.dxos.org/.well-known/dx/supervisor
     tunneling:

package/config/config.yml

@@ -4,25 +4,25 @@ runtime:
   client:
     storage:
       persistent: true
-      path: '/tmp/dx/cli'
+      path: /tmp/dx/run
 
   services:
     ipfs:
-      server: "http://kube.dxos.org:5001/"
-      gateway: "http://kube.dxos.org:8888/ipfs"
+      server: http://kube.dxos.org:5001/
+      gateway: http://kube.dxos.org:8888/ipfs
     signaling:
-      - server: 'wss://kube.dxos.org/.well-known/dx/signal'
-      - server: 'wss://dx.dev.kube.dxos.org/.well-known/dx/signal'
+      - server: wss://kube.dxos.org/.well-known/dx/signal
+      - server: wss://dx.dev.kube.dxos.org/.well-known/dx/signal
     ice:
-      - urls: 'stun:kube.dxos.org:3478'
-      - urls: 'turn:kube.dxos.org:3478'
-        username: 'dxos'
-        credential: 'dxos'
+      - urls: stun:kube.dxos.org:3478
+      - urls: turn:kube.dxos.org:3478
+        username: dxos
+        credential: dxos
     publisher:
-      server: 'wss://kube.dxos.org/.well-known/dx/deploy'
+      server: wss://kube.dxos.org/.well-known/dx/deploy
     supervisor:
       server: wss://kube.dxos.org/.well-known/dx/supervisor
     tunneling:
       server: wss://kube.dxos.org/.well-known/dx/tunnel
     machine:
-      doAccessToken: ''
+      doAccessToken:

package/dist/src/base-command.d.ts

@@ -1,31 +1,64 @@
-import { Command, Config as OclifConfig } from '@oclif/core';
+import { Command, Config as OclifConfig, Interfaces } from '@oclif/core';
+import { Daemon } from '@dxos/agent';
 import { Client, Config } from '@dxos/client';
-import { Daemon } from './daemon';
-import { PublisherRpcPeer, SupervisorRpcPeer, TunnelRpcPeer, TelemetryContext } from './util';
-export declare abstract class BaseCommand extends Command {
+import { PublisherRpcPeer, SupervisorRpcPeer, TelemetryContext, TunnelRpcPeer } from './util';
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BaseCommand)['baseFlags'] & T['flags']>;
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+/**
+ * Custom base command.
+ * https://oclif.io/docs/base_class#docsNav
+ * Ref: https://github.com/salesforcecli/sf-plugins-core/blob/main/src/sfCommand.ts
+ */
+export declare abstract class BaseCommand<T extends typeof Command = any> extends Command {
     private _clientConfig?;
     private _client?;
     private _startTime;
     private _failing;
+    private readonly _stdin?;
+    protected flags: Flags<T>;
+    protected args: Args<T>;
     protected _telemetryContext?: TelemetryContext;
-    private _stdin?;
     static enableJsonFlag: boolean;
     static flags: {
-        config: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        timeout: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        profile: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'dry-run': Interfaces.BooleanFlag<boolean>;
+        verbose: Interfaces.BooleanFlag<boolean>;
+        profile: Interfaces.OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        config: Interfaces.OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'no-agent': Interfaces.BooleanFlag<boolean>;
+        timeout: Interfaces.OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
     constructor(argv: string[], config: OclifConfig);
-    get clientConfig(): Config | undefined;
+    get clientConfig(): Config;
     get stdin(): string | undefined;
-    ok(): void;
+    done(): void;
     /**
      * Load the client config.
      */
     init(): Promise<void>;
+    private _initTelemetry;
     private _loadConfig;
-    catch(err: Error): Promise<void>;
+    /**
+     * Use this method for user-facing messages.
+     * Use @dxos/logger for internal messages.
+     */
+    log(message: string, ...args: any[]): void;
+    /**
+     * Use this method for user-facing warnings.
+     * Use @dxos/logger for internal messages.
+     */
+    warn(err: string | Error): string | Error;
+    /**
+     * Use this method for user-facing errors.
+     * Use @dxos/logger for internal messages.
+     * NOTE: Full stack trace is displayed if `oclif.settings.debug = true` (see bin script).
+     * https://oclif.io/docs/error_handling
+     */
+    error(err: string | Error, options?: any): never;
+    /**
+     * Called after each command run.
+     */
     finally(): Promise<void>;
+    maybeStartDaemon(): Promise<void>;
     /**
      * Lazily create the client.
      */
@@ -33,10 +66,13 @@ export declare abstract class BaseCommand extends Command {
     /**
      * Convenience function to wrap command passing in client object.
      */
-    execWithClient<T>(callback: (client: Client) => Promise<T | undefined>): Promise<T | undefined>;
+    execWithClient<T>(callback: (client: Client) => Promise<T | undefined>, checkHalo?: boolean): Promise<T | undefined>;
+    /**
+     * Convenience function to wrap starting the agent.
+     */
     execWithDaemon<T>(callback: (daemon: Daemon) => Promise<T | undefined>): Promise<T | undefined>;
     /**
-     * Convenience function to wrap command passing in kube publisher.
+     * Convenience function to wrap command passing in KUBE publisher.
      */
     execWithPublisher<T>(callback: (rpc: PublisherRpcPeer) => Promise<T | undefined>): Promise<T | undefined>;
     execWithTunneling<T>(callback: (rpc: TunnelRpcPeer) => Promise<T | undefined>): Promise<T | undefined>;

package/dist/src/base-command.d.ts.map

@@ -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,MAAM,aAAa,CAAC;AAUpE,OAAO,EAAE,MAAM,EAAkC,MAAM,EAAE,MAAM,cAAc,CAAC;AAQ9E,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAIL,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EAEb,gBAAgB,EAEjB,MAAM,QAAQ,CAAC;AAkBhB,8BAAsB,WAAY,SAAQ,OAAO;IAC/C,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,UAAU,CAAO;IACzB,OAAO,CAAC,QAAQ,CAAS;IACzB,SAAS,CAAC,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IAE/C,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAuB,cAAc,UAAQ;IAC7C,OAAgB,KAAK;;;;MA4BnB;gBAEU,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,WAAW;IAY/C,IAAI,YAAY,uBAEf;IAED,IAAI,KAAK,uBAER;IAED,EAAE;IAIF;;OAEG;IACY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;YAoDtB,WAAW;IA4BV,KAAK,CAAC,GAAG,EAAE,KAAK;IAOhB,OAAO;IActB;;OAEG;IACG,SAAS;IAmBf;;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;IAe/F,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAgBrG;;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;IAyBzG,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAyBtG,kBAAkB,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IA0BjH,qBAAqB,CAAC,MAAM,EAAE,MAAM;CAUrC"}
+{"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,EAML,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,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,UAAU,CAAO;IACzB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IAEjC,SAAS,CAAC,KAAK,EAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3B,SAAS,CAAC,IAAI,EAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAEzB,SAAS,CAAC,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IAE/C,OAAuB,cAAc,UAAQ;IAE7C,OAAgB,KAAK;;;;;;;MAwCnB;gBAEU,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,WAAW;IAY/C,IAAI,YAAY,WAGf;IAED,IAAI,KAAK,uBAER;IAED,IAAI;IAIJ;;OAEG;IACY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;YAkBtB,cAAc;YA4Cd,WAAW;IAwBzB;;;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;IAatB;;OAEG;IACG,SAAS;IAmBf;;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"}