@contextual-io/cli 0.3.0 → 0.4.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @contextual-io/cli
 $ ctxl COMMAND
 running command...
 $ ctxl (--version)
-@contextual-io/cli/0.3.0 linux-x64 node-v25.2.1
+@contextual-io/cli/0.4.0 linux-x64 node-v25.2.1
 $ ctxl --help [COMMAND]
 USAGE
   $ ctxl COMMAND
@@ -48,6 +48,14 @@ USAGE
 * [`ctxl records list [URI]`](#ctxl-records-list-uri)
 * [`ctxl records query [URI]`](#ctxl-records-query-uri)
 * [`ctxl records replace [URI]`](#ctxl-records-replace-uri)
+* [`ctxl types <COMMAND>`](#ctxl-types-command)
+* [`ctxl types add`](#ctxl-types-add)
+* [`ctxl types create`](#ctxl-types-create)
+* [`ctxl types delete [URI]`](#ctxl-types-delete-uri)
+* [`ctxl types get [URI]`](#ctxl-types-get-uri)
+* [`ctxl types import`](#ctxl-types-import)
+* [`ctxl types list`](#ctxl-types-list)
+* [`ctxl types replace [URI]`](#ctxl-types-replace-uri)
 
 ## `ctxl autocomplete [SHELL]`
 
@@ -82,19 +90,19 @@ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomp
 
 ## `ctxl config <COMMAND>`
 
-manage configs
+Manage configs.
 
 ```
 USAGE
   $ ctxl config <COMMAND>
 
 DESCRIPTION
-  manage configs
+  Manage configs.
 ```
 
 ## `ctxl config add CONFIG-ID`
 
-add a new config
+Add a new config.
 
 ```
 USAGE
@@ -109,7 +117,7 @@ FLAGS
   -t, --tenant-id=<value>  tenant id (if different from config id)
 
 DESCRIPTION
-  add a new config
+  Add a new config.
 
 EXAMPLES
   $ ctxl config add some-config-id --tenant-id my-tenant
@@ -117,7 +125,7 @@ EXAMPLES
 
 ## `ctxl config current`
 
-get the current config
+Get the current config.
 
 ```
 USAGE
@@ -127,7 +135,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  get the current config
+  Get the current config.
 
 EXAMPLES
   $ ctxl config current
@@ -135,7 +143,7 @@ EXAMPLES
 
 ## `ctxl config delete CONFIG-ID`
 
-delete a config
+Delete a config.
 
 ```
 USAGE
@@ -145,7 +153,7 @@ ARGUMENTS
   CONFIG-ID  id of config
 
 DESCRIPTION
-  delete a config
+  Delete a config.
 
 EXAMPLES
   $ ctxl config delete some-config-id
@@ -153,7 +161,7 @@ EXAMPLES
 
 ## `ctxl config get [CONFIG-ID]`
 
-get a specific config
+Get a specific config.
 
 ```
 USAGE
@@ -166,7 +174,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  get a specific config
+  Get a specific config.
 
 EXAMPLES
   $ ctxl config get
@@ -176,7 +184,7 @@ EXAMPLES
 
 ## `ctxl config list`
 
-list all available configs
+List all available configs.
 
 ```
 USAGE
@@ -186,7 +194,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  list all available configs
+  List all available configs.
 
 EXAMPLES
   $ ctxl config list
@@ -194,14 +202,14 @@ EXAMPLES
 
 ## `ctxl config login`
 
-login using the current config
+Login using the current config.
 
 ```
 USAGE
   $ ctxl config login
 
 DESCRIPTION
-  login using the current config
+  Login using the current config.
 
 EXAMPLES
   $ ctxl config login
@@ -209,7 +217,7 @@ EXAMPLES
 
 ## `ctxl config use CONFIG-ID`
 
-use a config
+Use a config.
 
 ```
 USAGE
@@ -219,7 +227,7 @@ ARGUMENTS
   CONFIG-ID  id of config
 
 DESCRIPTION
-  use a config
+  Use a config.
 
 EXAMPLES
   $ ctxl config use some-config-id
@@ -247,19 +255,19 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.3
 
 ## `ctxl records <COMMAND>`
 
-manage records
+Manage records.
 
 ```
 USAGE
   $ ctxl records <COMMAND>
 
 DESCRIPTION
-  manage records
+  Manage records.
 ```
 
 ## `ctxl records add [URI]`
 
-create record(s)
+Create record(s).
 
 ```
 USAGE
@@ -276,7 +284,7 @@ GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
 
 DESCRIPTION
-  create record(s)
+  Create record(s).
 
 ALIASES
   $ ctxl records create
@@ -290,7 +298,7 @@ EXAMPLES
 
 ## `ctxl records create [URI]`
 
-create record(s)
+Create record(s).
 
 ```
 USAGE
@@ -307,7 +315,7 @@ GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
 
 DESCRIPTION
-  create record(s)
+  Create record(s).
 
 ALIASES
   $ ctxl records create
@@ -321,7 +329,7 @@ EXAMPLES
 
 ## `ctxl records delete [URI]`
 
-delete record(s)
+Delete record(s).
 
 ```
 USAGE
@@ -338,7 +346,7 @@ GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
 
 DESCRIPTION
-  delete record(s)
+  Delete record(s).
 
 EXAMPLES
   $ ctxl records delete native-object:my-type/instance-1
@@ -354,7 +362,7 @@ EXAMPLES
 
 ## `ctxl records get [URI]`
 
-get a record
+Get a record.
 
 ```
 USAGE
@@ -371,7 +379,7 @@ GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
 
 DESCRIPTION
-  get a record
+  Get a record.
 
 EXAMPLES
   $ ctxl records get native-object:my-type/instance-1
@@ -387,7 +395,7 @@ EXAMPLES
 
 ## `ctxl records import [URI]`
 
-create record(s)
+Create record(s).
 
 ```
 USAGE
@@ -404,7 +412,7 @@ GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
 
 DESCRIPTION
-  create record(s)
+  Create record(s).
 
 ALIASES
   $ ctxl records create
@@ -418,7 +426,7 @@ EXAMPLES
 
 ## `ctxl records list [URI]`
 
-list records
+List records.
 
 ```
 USAGE
@@ -445,7 +453,7 @@ GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
 
 DESCRIPTION
-  list records
+  List records.
 
 EXAMPLES
   $ ctxl records list native-object:my-type
@@ -459,7 +467,7 @@ EXAMPLES
 
 ## `ctxl records query [URI]`
 
-query records
+Query records.
 
 ```
 USAGE
@@ -483,7 +491,7 @@ GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
 
 DESCRIPTION
-  query records
+  Query records.
 
 EXAMPLES
   $ ctxl records query native-object:my-type
@@ -497,7 +505,7 @@ EXAMPLES
 
 ## `ctxl records replace [URI]`
 
-replace a record
+Replace a record.
 
 ```
 USAGE
@@ -515,7 +523,7 @@ GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
 
 DESCRIPTION
-  replace a record
+  Replace a record.
 
 EXAMPLES
   $ ctxl records replace native-object:my-type/instance-1 --input-file record.json
@@ -524,4 +532,211 @@ EXAMPLES
 
   $ ctxl records replace --type my-type --id instance-1 --input-file record.json
 ```
+
+## `ctxl types <COMMAND>`
+
+Manage types.
+
+```
+USAGE
+  $ ctxl types <COMMAND>
+
+DESCRIPTION
+  Manage types.
+```
+
+## `ctxl types add`
+
+Create type(s).
+
+```
+USAGE
+  $ ctxl types add [-C <value>] [-i <value>]
+
+FLAGS
+  -i, --input-file=<value>  [default: -] file to read. can read stdin if value is '-'
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Create type(s).
+
+ALIASES
+  $ ctxl types create
+  $ ctxl types import
+
+EXAMPLES
+  $ ctxl types add
+
+  $ ctxl types add --input-file types.json
+```
+
+## `ctxl types create`
+
+Create type(s).
+
+```
+USAGE
+  $ ctxl types create [-C <value>] [-i <value>]
+
+FLAGS
+  -i, --input-file=<value>  [default: -] file to read. can read stdin if value is '-'
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Create type(s).
+
+ALIASES
+  $ ctxl types create
+  $ ctxl types import
+
+EXAMPLES
+  $ ctxl types create
+
+  $ ctxl types create --input-file types.json
+```
+
+## `ctxl types delete [URI]`
+
+Delete a type.
+
+```
+USAGE
+  $ ctxl types delete [URI] [-C <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -T, --type=<value>  type
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Delete a type.
+
+EXAMPLES
+  $ ctxl types delete native-object:my-type
+
+  $ ctxl types delete --type my-type
+```
+
+## `ctxl types get [URI]`
+
+Get a type.
+
+```
+USAGE
+  $ ctxl types get [URI] [-C <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -T, --type=<value>  type
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Get a type.
+
+EXAMPLES
+  $ ctxl types get native-object:my-type
+
+  $ ctxl types get --type my-type
+```
+
+## `ctxl types import`
+
+Create type(s).
+
+```
+USAGE
+  $ ctxl types import [-C <value>] [-i <value>]
+
+FLAGS
+  -i, --input-file=<value>  [default: -] file to read. can read stdin if value is '-'
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Create type(s).
+
+ALIASES
+  $ ctxl types create
+  $ ctxl types import
+
+EXAMPLES
+  $ ctxl types import
+
+  $ ctxl types import --input-file types.json
+```
+
+## `ctxl types list`
+
+List types.
+
+```
+USAGE
+  $ ctxl types list [-C <value>] [-S <value>...] [-e] [-f <value>...] [--include-total] [-o <value>...]
+    [--page-size <value>] [--page-token <value>] [-p] [-s <value>...] [-t <value>...]
+
+FLAGS
+  -S, --exact-search=<value>...  search fields exactly
+  -e, --export                   export data as JSONL
+  -f, --from=<value>...          search from
+  -o, --order-by=<value>...      order fields
+  -p, --progress                 show progress during export
+  -s, --search=<value>...        search fields
+  -t, --to=<value>...            search to
+      --include-total            include total count
+      --page-size=<value>        number of types per page
+      --page-token=<value>       page token to fetch
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  List types.
+
+EXAMPLES
+  $ ctxl types list
+
+  $ ctxl types list --order-by field1:desc
+
+  $ ctxl types list -s field1=value1 -s field2=value2 --include-total
+```
+
+## `ctxl types replace [URI]`
+
+Replace a type.
+
+```
+USAGE
+  $ ctxl types replace [URI] [-C <value>] [-i <value>] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -T, --type=<value>        type
+  -i, --input-file=<value>  [default: -] file to read. can read stdin if value is '-'
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Replace a type.
+
+EXAMPLES
+  $ ctxl types replace native-object:my-type --input-file record.json
+
+  $ ctxl types replace --type my-type  --input-file record.json
+```
 <!-- commandsstop -->

package/dist/base.js

@@ -114,7 +114,9 @@ export class BaseConfigCommand extends Command {
             }
             this.logToStderr(chalkStderr.red(chalkStderr.bold("    Error: ") + message));
             this.logToStderr();
-            await this.showHelp();
+            if (!(err instanceof HttpError)) {
+                await this.showHelp();
+            }
         }
         this.exit(exitCode);
     }

package/dist/commands/config/add.js

@@ -7,7 +7,7 @@ export default class ConfigAdd extends BaseConfigCommand {
     static args = {
         "config-id": Args.string({ description: "id of config", required: true }),
     };
-    static description = "add a new config";
+    static description = "Add a new config.";
     static examples = [
         "<%= config.bin %> <%= command.id %> some-config-id --tenant-id my-tenant",
     ];

package/dist/commands/config/current.js

@@ -1,7 +1,7 @@
 import { BaseConfigCommand } from "../../base.js";
 export default class ConfigCurrent extends BaseConfigCommand {
     static args = {};
-    static description = "get the current config";
+    static description = "Get the current config.";
     static enableJsonFlag = true;
     static examples = [
         "<%= config.bin %> <%= command.id %>",

package/dist/commands/config/delete.js

@@ -5,7 +5,7 @@ export default class ConfigDelete extends BaseConfigCommand {
     static args = {
         "config-id": Args.string({ description: "id of config", required: true }),
     };
-    static description = "delete a config";
+    static description = "Delete a config.";
     static examples = [
         "<%= config.bin %> <%= command.id %> some-config-id",
     ];

package/dist/commands/config/get.js

@@ -6,7 +6,7 @@ export default class ConfigGet extends BaseConfigCommand {
     static args = {
         "config-id": Args.string({ description: "id of config" }),
     };
-    static description = "get a specific config";
+    static description = "Get a specific config.";
     static enableJsonFlag = true;
     static examples = [
         "<%= config.bin %> <%= command.id %>",

package/dist/commands/config/index.js

@@ -1,7 +1,7 @@
 import { BaseConfigCommand } from "../../base.js";
 export default class Config extends BaseConfigCommand {
     static args = {};
-    static description = "manage configs";
+    static description = "Manage configs.";
     static examples = [];
     static flags = {};
     static usage = [

package/dist/commands/config/list.js

@@ -3,7 +3,7 @@ import chalk from "chalk";
 import { BaseConfigCommand } from "../../base.js";
 export default class ConfigList extends BaseConfigCommand {
     static args = {};
-    static description = "list all available configs";
+    static description = "List all available configs.";
     static enableJsonFlag = true;
     static examples = [
         "<%= config.bin %> <%= command.id %>",

package/dist/commands/config/login.js

@@ -2,7 +2,7 @@ import { BaseConfigCommand } from "../../base.js";
 import { codeExchange, getUserProfile } from "../../utils/auth.js";
 export default class ConfigLogin extends BaseConfigCommand {
     static args = {};
-    static description = "login using the current config";
+    static description = "Login using the current config.";
     static examples = [
         "<%= config.bin %> <%= command.id %>",
     ];

package/dist/commands/config/use.js

@@ -5,7 +5,7 @@ export default class ConfigUse extends BaseConfigCommand {
     static args = {
         "config-id": Args.string({ description: "id of config", required: true }),
     };
-    static description = "use a config";
+    static description = "Use a config.";
     static examples = [
         "<%= config.bin %> <%= command.id %> some-config-id",
     ];

package/dist/commands/records/add.js

@@ -11,7 +11,7 @@ export default class RecordsAdd extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of type" }),
     };
-    static description = "create record(s)";
+    static description = "Create record(s).";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type",
         "<%= config.bin %> <%= command.id %> --type my-type --input-file records.json",

package/dist/commands/records/delete.js

@@ -6,7 +6,7 @@ export default class RecordsDelete extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of record" }),
     };
-    static description = "delete record(s)";
+    static description = "Delete record(s).";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1",
         "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1",

package/dist/commands/records/get.js

@@ -6,7 +6,7 @@ export default class RecordsGet extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of record" }),
     };
-    static description = "get a record";
+    static description = "Get a record.";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1",
         "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1",

package/dist/commands/records/index.js

@@ -1,7 +1,7 @@
 import { BaseConfigCommand } from "../../base.js";
 export default class Records extends BaseConfigCommand {
     static args = {};
-    static description = "manage records";
+    static description = "Manage records.";
     static examples = [];
     static flags = {};
     static usage = [

package/dist/commands/records/list.js

@@ -12,7 +12,7 @@ export default class RecordsList extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of type" }),
     };
-    static description = "list records";
+    static description = "List records.";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type",
         "<%= config.bin %> <%= command.id %> --type my-type",

package/dist/commands/records/query.js

@@ -10,7 +10,7 @@ export default class RecordsQuery extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of type" }),
     };
-    static description = "query records";
+    static description = "Query records.";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type",
         "<%= config.bin %> <%= command.id %> --type my-type --query-file query.json",

package/dist/commands/records/replace.js

@@ -9,7 +9,7 @@ export default class RecordsReplace extends BaseCommand {
     static args = {
         "uri": Args.string({ description: "uri of record" }),
     };
-    static description = "replace a record";
+    static description = "Replace a record.";
     static examples = [
         "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1 --input-file record.json",
         "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1 --input-file record.json",

package/dist/commands/types/add.d.ts

@@ -0,0 +1,11 @@
+import { BaseCommand } from "../../base.js";
+export default class TypesAdd extends BaseCommand<typeof TypesAdd> {
+    static aliases: string[];
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {
+        "input-file": import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}