@contextual-io/cli 0.3.1 → 0.5.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.1 linux-x64 node-v25.2.1
+@contextual-io/cli/0.5.0 linux-x64 node-v25.2.1
 $ ctxl --help [COMMAND]
 USAGE
   $ ctxl COMMAND
@@ -46,8 +46,19 @@ USAGE
 * [`ctxl records get [URI]`](#ctxl-records-get-uri)
 * [`ctxl records import [URI]`](#ctxl-records-import-uri)
 * [`ctxl records list [URI]`](#ctxl-records-list-uri)
+* [`ctxl records patch [URI]`](#ctxl-records-patch-uri)
 * [`ctxl records query [URI]`](#ctxl-records-query-uri)
 * [`ctxl records replace [URI]`](#ctxl-records-replace-uri)
+* [`ctxl records search [URI]`](#ctxl-records-search-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 types search`](#ctxl-types-search)
 
 ## `ctxl autocomplete [SHELL]`
 
@@ -82,34 +93,32 @@ _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
-  $ ctxl config add CONFIG-ID [-s prod|qa|dev] [-t <value>]
+  $ ctxl config add CONFIG-ID [-t <value>]
 
 ARGUMENTS
   CONFIG-ID  id of config
 
 FLAGS
-  -s, --silo=<option>      [default: prod] silo
-                           <options: prod|qa|dev>
   -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 +126,7 @@ EXAMPLES
 
 ## `ctxl config current`
 
-get the current config
+Get the current config.
 
 ```
 USAGE
@@ -127,7 +136,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  get the current config
+  Get the current config.
 
 EXAMPLES
   $ ctxl config current
@@ -135,7 +144,7 @@ EXAMPLES
 
 ## `ctxl config delete CONFIG-ID`
 
-delete a config
+Delete a config.
 
 ```
 USAGE
@@ -145,7 +154,7 @@ ARGUMENTS
   CONFIG-ID  id of config
 
 DESCRIPTION
-  delete a config
+  Delete a config.
 
 EXAMPLES
   $ ctxl config delete some-config-id
@@ -153,7 +162,7 @@ EXAMPLES
 
 ## `ctxl config get [CONFIG-ID]`
 
-get a specific config
+Get a specific config.
 
 ```
 USAGE
@@ -166,7 +175,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  get a specific config
+  Get a specific config.
 
 EXAMPLES
   $ ctxl config get
@@ -176,7 +185,7 @@ EXAMPLES
 
 ## `ctxl config list`
 
-list all available configs
+List all available configs.
 
 ```
 USAGE
@@ -186,7 +195,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  list all available configs
+  List all available configs.
 
 EXAMPLES
   $ ctxl config list
@@ -194,14 +203,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 +218,7 @@ EXAMPLES
 
 ## `ctxl config use CONFIG-ID`
 
-use a config
+Use a config.
 
 ```
 USAGE
@@ -219,7 +228,7 @@ ARGUMENTS
   CONFIG-ID  id of config
 
 DESCRIPTION
-  use a config
+  Use a config.
 
 EXAMPLES
   $ ctxl config use some-config-id
@@ -247,19 +256,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 +285,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 +299,7 @@ EXAMPLES
 
 ## `ctxl records create [URI]`
 
-create record(s)
+Create record(s).
 
 ```
 USAGE
@@ -307,7 +316,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,24 +330,24 @@ EXAMPLES
 
 ## `ctxl records delete [URI]`
 
-delete record(s)
+Delete record(s).
 
 ```
 USAGE
-  $ ctxl records delete [URI] [-C <value>] [-i <value>...] [-T <value>]
+  $ ctxl records delete [URI] [-C <value>] [-I <value>...] [-T <value>]
 
 ARGUMENTS
   [URI]  uri of record
 
 FLAGS
+  -I, --id=<value>...  id(s)
   -T, --type=<value>   type
-  -i, --id=<value>...  id(s)
 
 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,24 +363,24 @@ EXAMPLES
 
 ## `ctxl records get [URI]`
 
-get a record
+Get a record.
 
 ```
 USAGE
-  $ ctxl records get [URI] [-C <value>] [-i <value>...] [-T <value>]
+  $ ctxl records get [URI] [-C <value>] [-I <value>...] [-T <value>]
 
 ARGUMENTS
   [URI]  uri of record
 
 FLAGS
+  -I, --id=<value>...  id(s)
   -T, --type=<value>   type
-  -i, --id=<value>...  id(s)
 
 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 +396,7 @@ EXAMPLES
 
 ## `ctxl records import [URI]`
 
-create record(s)
+Create record(s).
 
 ```
 USAGE
@@ -404,7 +413,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 +427,7 @@ EXAMPLES
 
 ## `ctxl records list [URI]`
 
-list records
+List records.
 
 ```
 USAGE
@@ -445,7 +454,10 @@ GLOBAL FLAGS
   -C, --config-id=<value>  Specify config id to use for call.
 
 DESCRIPTION
-  list records
+  List records.
+
+ALIASES
+  $ ctxl records search
 
 EXAMPLES
   $ ctxl records list native-object:my-type
@@ -457,9 +469,44 @@ EXAMPLES
   $ ctxl records list --type my-type -s field1=value1 -s field2=value2 --include-total
 ```
 
+## `ctxl records patch [URI]`
+
+Patch a record.
+
+```
+USAGE
+  $ ctxl records patch [URI] [-C <value>] [-a <value>...] [-I <value>] [-i <value>...] [-d <value>...] [-r
+    <value>...] [-s <value>...] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of record
+
+FLAGS
+  -I, --id=<value>            id
+  -T, --type=<value>          type
+  -a, --add=<value>...        add field
+  -d, --remove=<value>...     remove field
+  -i, --increment=<value>...  increment field
+  -r, --replace=<value>...    replace field
+  -s, --set=<value>...        set field
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  Patch a record.
+
+EXAMPLES
+  $ ctxl records patch native-object:my-type/instance-1 --set field1=value1
+
+  $ ctxl records patch native-object:my-type --id instance-1 --remove field2
+
+  $ ctxl records patch --type my-type --id instance-1 --increment field3=2
+```
+
 ## `ctxl records query [URI]`
 
-query records
+Query records.
 
 ```
 USAGE
@@ -483,7 +530,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,25 +544,25 @@ EXAMPLES
 
 ## `ctxl records replace [URI]`
 
-replace a record
+Replace a record.
 
 ```
 USAGE
-  $ ctxl records replace [URI] [-C <value>] [-i <value>] [-i <value>] [-T <value>]
+  $ ctxl records replace [URI] [-C <value>] [-I <value>] [-i <value>] [-T <value>]
 
 ARGUMENTS
   [URI]  uri of record
 
 FLAGS
+  -I, --id=<value>          id
   -T, --type=<value>        type
-  -i, --id=<value>          id
   -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 record
+  Replace a record.
 
 EXAMPLES
   $ ctxl records replace native-object:my-type/instance-1 --input-file record.json
@@ -524,4 +571,296 @@ EXAMPLES
 
   $ ctxl records replace --type my-type --id instance-1 --input-file record.json
 ```
+
+## `ctxl records search [URI]`
+
+List records.
+
+```
+USAGE
+  $ ctxl records search [URI] [-C <value>] [-S <value>...] [-e] [-f <value>...] [--include-total] [-o <value>...]
+    [--page-size <value>] [--page-token <value>] [-p] [-s <value>...] [-t <value>...] [-T <value>]
+
+ARGUMENTS
+  [URI]  uri of type
+
+FLAGS
+  -S, --exact-search=<value>...  search fields exactly
+  -T, --type=<value>             type
+  -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 records per page
+      --page-token=<value>       page token to fetch
+
+GLOBAL FLAGS
+  -C, --config-id=<value>  Specify config id to use for call.
+
+DESCRIPTION
+  List records.
+
+ALIASES
+  $ ctxl records search
+
+EXAMPLES
+  $ ctxl records search native-object:my-type
+
+  $ ctxl records search --type my-type
+
+  $ ctxl records search --type my-type --order-by field1:desc
+
+  $ ctxl records search --type my-type -s field1=value1 -s field2=value2 --include-total
+```
+
+## `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.
+
+ALIASES
+  $ ctxl types search
+
+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
+```
+
+## `ctxl types search`
+
+List types.
+
+```
+USAGE
+  $ ctxl types search [-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.
+
+ALIASES
+  $ ctxl types search
+
+EXAMPLES
+  $ ctxl types search
+
+  $ ctxl types search --order-by field1:desc
+
+  $ ctxl types search -s field1=value1 -s field2=value2 --include-total
+```
 <!-- commandsstop -->

package/dist/base.d.ts

@@ -7,7 +7,11 @@ export type Args<T extends typeof Command> = Interfaces.InferredArgs<T["args"]>;
 declare class CommandConfig {
     private readonly configDir;
     constructor(configDir: string);
-    clean(configId: UrlSafeId, { silo, tenantId }: Config): CleanConfig;
+    cleanJson(configId: UrlSafeId, { silo, tenantId }: Config): CleanConfig;
+    cleanTable(configId: UrlSafeId, config: Config): {
+        tenantId: string;
+        configId: string;
+    };
     get(configId?: UrlSafeId): Promise<{
         config: Config;
         lookup: string;