@contextual-io/cli 0.3.1 → 0.5.0

package/oclif.manifest.json

@@ -9,7 +9,7 @@
           "required": true
         }
       },
-      "description": "add a new config",
+      "description": "Add a new config.",
       "examples": [
         "<%= config.bin %> <%= command.id %> some-config-id --tenant-id my-tenant"
       ],
@@ -17,6 +17,7 @@
         "silo": {
           "char": "s",
           "description": "silo",
+          "hidden": true,
           "name": "silo",
           "default": "prod",
           "hasDynamicHelp": false,
@@ -56,7 +57,7 @@
     "config:current": {
       "aliases": [],
       "args": {},
-      "description": "get the current config",
+      "description": "Get the current config.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -94,7 +95,7 @@
           "required": true
         }
       },
-      "description": "delete a config",
+      "description": "Delete a config.",
       "examples": [
         "<%= config.bin %> <%= command.id %> some-config-id"
       ],
@@ -123,7 +124,7 @@
           "name": "config-id"
         }
       },
-      "description": "get a specific config",
+      "description": "Get a specific config.",
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> some-config-id"
@@ -156,7 +157,7 @@
     "config": {
       "aliases": [],
       "args": {},
-      "description": "manage configs",
+      "description": "Manage configs.",
       "examples": [],
       "flags": {},
       "hasDynamicHelp": false,
@@ -181,7 +182,7 @@
     "config:list": {
       "aliases": [],
       "args": {},
-      "description": "list all available configs",
+      "description": "List all available configs.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -213,7 +214,7 @@
     "config:login": {
       "aliases": [],
       "args": {},
-      "description": "login using the current config",
+      "description": "Login using the current config.",
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -243,7 +244,7 @@
           "required": true
         }
       },
-      "description": "use a config",
+      "description": "Use a config.",
       "examples": [
         "<%= config.bin %> <%= command.id %> some-config-id"
       ],
@@ -275,7 +276,7 @@
           "name": "uri"
         }
       },
-      "description": "create record(s)",
+      "description": "Create record(s).",
       "examples": [
         "<%= config.bin %> <%= command.id %> native-object:my-type",
         "<%= config.bin %> <%= command.id %> --type my-type --input-file records.json"
@@ -332,7 +333,7 @@
           "name": "uri"
         }
       },
-      "description": "delete record(s)",
+      "description": "Delete record(s).",
       "examples": [
         "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1",
         "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1",
@@ -351,7 +352,7 @@
           "type": "option"
         },
         "id": {
-          "char": "i",
+          "char": "I",
           "description": "id(s)",
           "name": "id",
           "hasDynamicHelp": false,
@@ -391,7 +392,7 @@
           "name": "uri"
         }
       },
-      "description": "get a record",
+      "description": "Get a record.",
       "examples": [
         "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1",
         "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1",
@@ -410,7 +411,7 @@
           "type": "option"
         },
         "id": {
-          "char": "i",
+          "char": "I",
           "description": "id(s)",
           "name": "id",
           "hasDynamicHelp": false,
@@ -445,7 +446,7 @@
     "records": {
       "aliases": [],
       "args": {},
-      "description": "manage records",
+      "description": "Manage records.",
       "examples": [],
       "flags": {},
       "hasDynamicHelp": false,
@@ -468,14 +469,16 @@
       ]
     },
     "records:list": {
-      "aliases": [],
+      "aliases": [
+        "records:search"
+      ],
       "args": {
         "uri": {
           "description": "uri of type",
           "name": "uri"
         }
       },
-      "description": "list records",
+      "description": "List records.",
       "examples": [
         "<%= config.bin %> <%= command.id %> native-object:my-type",
         "<%= config.bin %> <%= command.id %> --type my-type",
@@ -591,6 +594,103 @@
         "list.js"
       ]
     },
+    "records:patch": {
+      "aliases": [],
+      "args": {
+        "uri": {
+          "description": "uri of record",
+          "name": "uri"
+        }
+      },
+      "description": "Patch a record.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> native-object:my-type/instance-1 --set field1=value1",
+        "<%= config.bin %> <%= command.id %> native-object:my-type --id instance-1 --remove field2",
+        "<%= config.bin %> <%= command.id %> --type my-type --id instance-1 --increment field3=2"
+      ],
+      "flags": {
+        "config-id": {
+          "char": "C",
+          "helpGroup": "GLOBAL",
+          "name": "config-id",
+          "summary": "Specify config id to use for call.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "add": {
+          "char": "a",
+          "description": "add field",
+          "name": "add",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "id": {
+          "char": "I",
+          "description": "id",
+          "name": "id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "increment": {
+          "char": "i",
+          "description": "increment field",
+          "name": "increment",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "remove": {
+          "char": "d",
+          "description": "remove field",
+          "name": "remove",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "replace": {
+          "char": "r",
+          "description": "replace field",
+          "name": "replace",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "set": {
+          "char": "s",
+          "description": "set field",
+          "name": "set",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "type": {
+          "char": "T",
+          "description": "type",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "records:patch",
+      "pluginAlias": "@contextual-io/cli",
+      "pluginName": "@contextual-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "records",
+        "patch.js"
+      ]
+    },
     "records:query": {
       "aliases": [],
       "args": {
@@ -599,7 +699,7 @@
           "name": "uri"
         }
       },
-      "description": "query records",
+      "description": "Query records.",
       "examples": [
         "<%= config.bin %> <%= command.id %> native-object:my-type",
         "<%= config.bin %> <%= command.id %> --type my-type --query-file query.json",
@@ -700,7 +800,7 @@
           "name": "uri"
         }
       },
-      "description": "replace a record",
+      "description": "Replace a record.",
       "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",
@@ -717,7 +817,7 @@
           "type": "option"
         },
         "id": {
-          "char": "i",
+          "char": "I",
           "description": "id",
           "name": "id",
           "hasDynamicHelp": false,
@@ -757,7 +857,344 @@
         "records",
         "replace.js"
       ]
+    },
+    "types:add": {
+      "aliases": [
+        "types:create",
+        "types:import"
+      ],
+      "args": {},
+      "description": "Create type(s).",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --input-file types.json"
+      ],
+      "flags": {
+        "config-id": {
+          "char": "C",
+          "helpGroup": "GLOBAL",
+          "name": "config-id",
+          "summary": "Specify config id to use for call.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "input-file": {
+          "char": "i",
+          "description": "file to read. can read stdin if value is '-'",
+          "name": "input-file",
+          "default": "-",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "types:add",
+      "pluginAlias": "@contextual-io/cli",
+      "pluginName": "@contextual-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "types",
+        "add.js"
+      ]
+    },
+    "types:delete": {
+      "aliases": [],
+      "args": {
+        "uri": {
+          "description": "uri of type",
+          "name": "uri"
+        }
+      },
+      "description": "Delete a type.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> native-object:my-type",
+        "<%= config.bin %> <%= command.id %> --type my-type"
+      ],
+      "flags": {
+        "config-id": {
+          "char": "C",
+          "helpGroup": "GLOBAL",
+          "name": "config-id",
+          "summary": "Specify config id to use for call.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "type": {
+          "char": "T",
+          "description": "type",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "types:delete",
+      "pluginAlias": "@contextual-io/cli",
+      "pluginName": "@contextual-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "types",
+        "delete.js"
+      ]
+    },
+    "types:get": {
+      "aliases": [],
+      "args": {
+        "uri": {
+          "description": "uri of type",
+          "name": "uri"
+        }
+      },
+      "description": "Get a type.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> native-object:my-type",
+        "<%= config.bin %> <%= command.id %> --type my-type"
+      ],
+      "flags": {
+        "config-id": {
+          "char": "C",
+          "helpGroup": "GLOBAL",
+          "name": "config-id",
+          "summary": "Specify config id to use for call.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "type": {
+          "char": "T",
+          "description": "type",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "types:get",
+      "pluginAlias": "@contextual-io/cli",
+      "pluginName": "@contextual-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "types",
+        "get.js"
+      ]
+    },
+    "types": {
+      "aliases": [],
+      "args": {},
+      "description": "Manage types.",
+      "examples": [],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "types",
+      "pluginAlias": "@contextual-io/cli",
+      "pluginName": "@contextual-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "usage": [
+        "<%= command.id %> <COMMAND>"
+      ],
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "types",
+        "index.js"
+      ]
+    },
+    "types:list": {
+      "aliases": [
+        "types:search"
+      ],
+      "args": {},
+      "description": "List types.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --order-by field1:desc",
+        "<%= config.bin %> <%= command.id %> -s field1=value1 -s field2=value2 --include-total"
+      ],
+      "flags": {
+        "config-id": {
+          "char": "C",
+          "helpGroup": "GLOBAL",
+          "name": "config-id",
+          "summary": "Specify config id to use for call.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "exact-search": {
+          "char": "S",
+          "description": "search fields exactly",
+          "name": "exact-search",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "export": {
+          "char": "e",
+          "description": "export data as JSONL",
+          "name": "export",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "from": {
+          "char": "f",
+          "description": "search from",
+          "name": "from",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "include-total": {
+          "description": "include total count",
+          "name": "include-total",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "order-by": {
+          "char": "o",
+          "description": "order fields",
+          "name": "order-by",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "page-size": {
+          "description": "number of types per page",
+          "name": "page-size",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "page-token": {
+          "description": "page token to fetch",
+          "name": "page-token",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "progress": {
+          "char": "p",
+          "description": "show progress during export",
+          "name": "progress",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "search": {
+          "char": "s",
+          "description": "search fields",
+          "name": "search",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "to": {
+          "char": "t",
+          "description": "search to",
+          "name": "to",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "types:list",
+      "pluginAlias": "@contextual-io/cli",
+      "pluginName": "@contextual-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "types",
+        "list.js"
+      ]
+    },
+    "types:replace": {
+      "aliases": [],
+      "args": {
+        "uri": {
+          "description": "uri of type",
+          "name": "uri"
+        }
+      },
+      "description": "Replace a type.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> native-object:my-type --input-file record.json",
+        "<%= config.bin %> <%= command.id %> --type my-type  --input-file record.json"
+      ],
+      "flags": {
+        "config-id": {
+          "char": "C",
+          "helpGroup": "GLOBAL",
+          "name": "config-id",
+          "summary": "Specify config id to use for call.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "input-file": {
+          "char": "i",
+          "description": "file to read. can read stdin if value is '-'",
+          "name": "input-file",
+          "default": "-",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "type": {
+          "char": "T",
+          "description": "type",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "types:replace",
+      "pluginAlias": "@contextual-io/cli",
+      "pluginName": "@contextual-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "types",
+        "replace.js"
+      ]
     }
   },
-  "version": "0.3.1"
+  "version": "0.5.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contextual-io/cli",
   "description": "Contextual CLI",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "author": "Nasser Oloumi",
   "bin": {
     "ctxl": "./bin/run.js"