@contextual-io/cli 0.2.0 → 0.2.2

package/README.md

@@ -1,4 +1,4 @@
-contextual-cli
+@contextual-io/cli
 =================
 
 Contextual CLI
@@ -20,7 +20,7 @@ $ npm install -g @contextual-io/cli
 $ ctxl COMMAND
 running command...
 $ ctxl (--version)
-@contextual-io/cli/0.2.0 linux-x64 node-v25.2.1
+@contextual-io/cli/0.2.2 linux-x64 node-v25.2.1
 $ ctxl --help [COMMAND]
 USAGE
   $ ctxl COMMAND
@@ -29,7 +29,7 @@ USAGE
 <!-- usagestop -->
 # Commands
 <!-- commands -->
-* [`ctxl config`](#ctxl-config)
+* [`ctxl config <COMMAND>`](#ctxl-config-command)
 * [`ctxl config add CONFIG-ID`](#ctxl-config-add-config-id)
 * [`ctxl config current`](#ctxl-config-current)
 * [`ctxl config delete CONFIG-ID`](#ctxl-config-delete-config-id)
@@ -38,7 +38,7 @@ USAGE
 * [`ctxl config login`](#ctxl-config-login)
 * [`ctxl config use CONFIG-ID`](#ctxl-config-use-config-id)
 * [`ctxl help [COMMAND]`](#ctxl-help-command)
-* [`ctxl records`](#ctxl-records)
+* [`ctxl records <COMMAND>`](#ctxl-records-command)
 * [`ctxl records add [URI]`](#ctxl-records-add-uri)
 * [`ctxl records create [URI]`](#ctxl-records-create-uri)
 * [`ctxl records delete [URI]`](#ctxl-records-delete-uri)
@@ -48,20 +48,18 @@ USAGE
 * [`ctxl records query [URI]`](#ctxl-records-query-uri)
 * [`ctxl records replace [URI]`](#ctxl-records-replace-uri)
 
-## `ctxl config`
+## `ctxl config <COMMAND>`
 
 manage configs
 
 ```
 USAGE
-  $ ctxl config
+  $ ctxl config <COMMAND>
 
 DESCRIPTION
   manage configs
 ```
 
-_See code: [src/commands/config/index.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/config/index.ts)_
-
 ## `ctxl config add CONFIG-ID`
 
 add a new config
@@ -85,8 +83,6 @@ EXAMPLES
   $ ctxl config add some-config-id --tenant-id my-tenant
 ```
 
-_See code: [src/commands/config/add.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/config/add.ts)_
-
 ## `ctxl config current`
 
 get the current config
@@ -105,8 +101,6 @@ EXAMPLES
   $ ctxl config current
 ```
 
-_See code: [src/commands/config/current.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/config/current.ts)_
-
 ## `ctxl config delete CONFIG-ID`
 
 delete a config
@@ -125,8 +119,6 @@ EXAMPLES
   $ ctxl config delete some-config-id
 ```
 
-_See code: [src/commands/config/delete.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/config/delete.ts)_
-
 ## `ctxl config get [CONFIG-ID]`
 
 get a specific config
@@ -150,8 +142,6 @@ EXAMPLES
   $ ctxl config get some-config-id
 ```
 
-_See code: [src/commands/config/get.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/config/get.ts)_
-
 ## `ctxl config list`
 
 list all available configs
@@ -170,8 +160,6 @@ EXAMPLES
   $ ctxl config list
 ```
 
-_See code: [src/commands/config/list.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/config/list.ts)_
-
 ## `ctxl config login`
 
 login using the current config
@@ -187,8 +175,6 @@ EXAMPLES
   $ ctxl config login
 ```
 
-_See code: [src/commands/config/login.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/config/login.ts)_
-
 ## `ctxl config use CONFIG-ID`
 
 use a config
@@ -207,8 +193,6 @@ EXAMPLES
   $ ctxl config use some-config-id
 ```
 
-_See code: [src/commands/config/use.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/config/use.ts)_
-
 ## `ctxl help [COMMAND]`
 
 Display help for ctxl.
@@ -229,20 +213,18 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
 
-## `ctxl records`
+## `ctxl records <COMMAND>`
 
 manage records
 
 ```
 USAGE
-  $ ctxl records
+  $ ctxl records <COMMAND>
 
 DESCRIPTION
   manage records
 ```
 
-_See code: [src/commands/records/index.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/records/index.ts)_
-
 ## `ctxl records add [URI]`
 
 create record(s)
@@ -274,8 +256,6 @@ EXAMPLES
   $ ctxl records add --type my-type --input-file records.json
 ```
 
-_See code: [src/commands/records/add.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/records/add.ts)_
-
 ## `ctxl records create [URI]`
 
 create record(s)
@@ -340,8 +320,6 @@ EXAMPLES
   $ ctxl records delete --type my-type --id instance-1 --id instance-2
 ```
 
-_See code: [src/commands/records/delete.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/records/delete.ts)_
-
 ## `ctxl records get [URI]`
 
 get a record
@@ -375,8 +353,6 @@ EXAMPLES
   $ ctxl records get --type my-type --id instance-1 --id instance-2
 ```
 
-_See code: [src/commands/records/get.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/records/get.ts)_
-
 ## `ctxl records import [URI]`
 
 create record(s)
@@ -449,8 +425,6 @@ EXAMPLES
   $ ctxl records list --type my-type -s field1=value1 -s field2=value2 --include-total
 ```
 
-_See code: [src/commands/records/list.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/records/list.ts)_
-
 ## `ctxl records query [URI]`
 
 query records
@@ -489,8 +463,6 @@ EXAMPLES
   $ ctxl records query --type my-type --include-total --query-file query.json
 ```
 
-_See code: [src/commands/records/query.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/records/query.ts)_
-
 ## `ctxl records replace [URI]`
 
 replace a record
@@ -520,6 +492,4 @@ EXAMPLES
 
   $ ctxl records replace --type my-type --id instance-1 --input-file record.json
 ```
-
-_See code: [src/commands/records/replace.ts](https://github.com/ContextualIO/contextual-cli/blob/v0.2.0/src/commands/records/replace.ts)_
 <!-- commandsstop -->

package/dist/base.d.ts

@@ -25,9 +25,10 @@ export declare abstract class BaseConfigCommand<T extends typeof Command> extend
     protected userConfig: CommandConfig;
     protected catch(err: Error & {
         exitCode?: number;
-    }): Promise<unknown>;
+    }): Promise<void>;
     protected finally(_: Error | undefined): Promise<unknown>;
     init(): Promise<void>;
+    protected showHelp(argv?: string[]): Promise<void>;
 }
 export declare abstract class BaseCommand<T extends typeof Command> extends BaseConfigCommand<T> {
     static baseFlags: {

package/dist/base.js

@@ -1,7 +1,10 @@
-import { Command, Flags } from "@oclif/core";
+import { Command, Flags, loadHelpClass } from "@oclif/core";
+// eslint-disable-next-line unicorn/import-style
+import { chalkStderr } from "chalk";
 import fetch from "cross-fetch";
 import fs from "node:fs";
 import path from "node:path";
+import { z, ZodError } from "zod";
 import { HttpError } from "./models/errors.js";
 import { UserConfig } from "./models/user-config.js";
 import { rehydrateToken } from "./utils/auth.js";
@@ -97,9 +100,23 @@ export class BaseConfigCommand extends Command {
     flags;
     userConfig;
     async catch(err) {
-        // add any custom logic to handle errors from the command
-        // or simply return the parent class error handling
-        return super.catch(err);
+        const exitCode = err.exitCode ?? process.exitCode ?? 1;
+        if (this.jsonEnabled()) {
+            this.logJson(this.toErrorJson(err));
+        }
+        else {
+            if (!err.message)
+                throw err;
+            let { message } = err;
+            if (err instanceof ZodError) {
+                const flattened = z.flattenError(err);
+                message = flattened.formErrors.join("\n");
+            }
+            this.logToStderr(chalkStderr.red(chalkStderr.bold("    Error: ") + message));
+            this.logToStderr();
+            await this.showHelp();
+        }
+        this.exit(exitCode);
     }
     async finally(_) {
         // called after run and catch regardless of whether or not the command errored
@@ -118,6 +135,13 @@ export class BaseConfigCommand extends Command {
         this.args = args;
         this.userConfig = new CommandConfig(this.config.configDir);
     }
+    async showHelp(argv) {
+        const toShow = argv ?? this.id ? [this.id] : undefined;
+        if (!toShow)
+            return;
+        const help = new (await loadHelpClass(this.config))(this.config);
+        await help.showHelp(toShow);
+    }
 }
 export class BaseCommand extends BaseConfigCommand {
     // define flags that can be inherited by any command that extends BaseCommand

package/dist/commands/config/index.d.ts

@@ -4,5 +4,6 @@ export default class Config extends BaseConfigCommand<typeof Config> {
     static description: string;
     static examples: never[];
     static flags: {};
+    static usage: string[];
     run(): Promise<void>;
 }

package/dist/commands/config/index.js

@@ -1,11 +1,13 @@
-import { loadHelpClass } from "@oclif/core";
 import { BaseConfigCommand } from "../../base.js";
 export default class Config extends BaseConfigCommand {
     static args = {};
     static description = "manage configs";
     static examples = [];
     static flags = {};
+    static usage = [
+        "<%= command.id %> <COMMAND>",
+    ];
     async run() {
-        await new (await loadHelpClass(this.config))(this.config).showHelp([Config.id]);
+        await this.showHelp();
     }
 }

package/dist/commands/records/index.d.ts

@@ -4,5 +4,6 @@ export default class Records extends BaseConfigCommand<typeof Records> {
     static description: string;
     static examples: never[];
     static flags: {};
+    static usage: string[];
     run(): Promise<void>;
 }

package/dist/commands/records/index.js

@@ -1,11 +1,13 @@
-import { loadHelpClass } from "@oclif/core";
 import { BaseConfigCommand } from "../../base.js";
 export default class Records extends BaseConfigCommand {
     static args = {};
     static description = "manage records";
     static examples = [];
     static flags = {};
+    static usage = [
+        "<%= command.id %> <COMMAND>",
+    ];
     async run() {
-        await new (await loadHelpClass(this.config))(this.config).showHelp([Records.id]);
+        await this.showHelp();
     }
 }

package/dist/models/uri.js

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export const Uri = z.string().regex(/^native-object:[a-z0-9-]+(\/.+)?/);
+export const Uri = z.string().regex(/^native-object:[a-z0-9-]+(\/.+)?/, { error: "URI must match one of the following formats: 'native-object:<type-id>' or 'native-object:<type-id>/<instance-id>'" });
 export const parseUri = (uri) => {
     const parsed = Uri.parse(uri);
     const [type, id] = parsed.replace(/^native-object:/, "").split("/");

package/oclif.manifest.json

@@ -166,6 +166,9 @@
       "pluginName": "@contextual-io/cli",
       "pluginType": "core",
       "strict": true,
+      "usage": [
+        "<%= command.id %> <COMMAND>"
+      ],
       "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
@@ -452,6 +455,9 @@
       "pluginName": "@contextual-io/cli",
       "pluginType": "core",
       "strict": true,
+      "usage": [
+        "<%= command.id %> <COMMAND>"
+      ],
       "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
@@ -753,5 +759,5 @@
       ]
     }
   },
-  "version": "0.2.0"
+  "version": "0.2.2"
 }

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@contextual-io/cli",
   "description": "Contextual CLI",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "author": "Nasser Oloumi",
   "bin": {
     "ctxl": "./bin/run.js"
   },
-  "bugs": "https://github.com/ContextualIO/contextual-cli/issues",
   "dependencies": {
     "@oclif/core": "^4",
     "@oclif/plugin-help": "^6",
+    "@oclif/plugin-not-found": "^3.2.73",
     "@oclif/table": "^0.5.1",
     "chalk": "^5.6.2",
     "cross-fetch": "^4.1.0",
@@ -45,7 +45,7 @@
     "./dist",
     "./oclif.manifest.json"
   ],
-  "homepage": "https://github.com/ContextualIO/contextual-cli",
+  "homepage": "https://www.contextual.io/",
   "keywords": [
     "oclif"
   ],
@@ -57,7 +57,8 @@
     "dirname": "ctxl",
     "commands": "./dist/commands",
     "plugins": [
-      "@oclif/plugin-help"
+      "@oclif/plugin-help",
+      "@oclif/plugin-not-found"
     ],
     "topicSeparator": " ",
     "topics": {
@@ -66,7 +67,6 @@
       }
     }
   },
-  "repository": "ContextualIO/contextual-cli",
   "scripts": {
     "build": "shx rm -rf dist && tsc -b",
     "lint": "eslint",