@contrail/cli 2.0.3 → 2.0.5

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.0.3",
+  "version": "2.0.5",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -78,6 +78,14 @@
           "description": "Install the app's accompanying workflows",
           "required": false,
           "allowNo": false
+        },
+        "showHidden": {
+          "name": "showHidden",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show the option to install public but hidden apps",
+          "required": false,
+          "allowNo": false
         }
       },
       "args": {}
@@ -287,6 +295,110 @@
       },
       "args": {}
     },
+    "groups:export": {
+      "id": "groups:export",
+      "description": "Export all groups in the org.",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail groups export\n"
+      ],
+      "flags": {
+        "outDir": {
+          "name": "outDir",
+          "type": "option",
+          "char": "d",
+          "description": "The location for the file to be saved",
+          "required": false,
+          "multiple": false,
+          "default": "groups.yml"
+        },
+        "overwrite": {
+          "name": "overwrite",
+          "type": "boolean",
+          "description": "Replaces existing files if they exist",
+          "required": false,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "groups:upload": {
+      "id": "groups:upload",
+      "description": "Import all groups in the groups.yml file",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail groups import <GROUPS_FILE>\n"
+      ],
+      "flags": {},
+      "args": {
+        "groupsFile": {
+          "name": "groupsFile",
+          "description": "The .yml file containing the groups",
+          "required": true
+        }
+      }
+    },
+    "instance:export": {
+      "id": "instance:export",
+      "description": "Exports an data of an instance including types and users",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail instance export\n"
+      ],
+      "flags": {
+        "outDir": {
+          "name": "outDir",
+          "type": "option",
+          "description": "The directory to which to export the instance data. Defaults to the current directory",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        },
+        "overwrite": {
+          "name": "overwrite",
+          "type": "boolean",
+          "description": "Replaces any existing export files in outDir",
+          "required": false,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "instance:import": {
+      "id": "instance:import",
+      "description": "Import the data to an instance, including types and users",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail instance import\n"
+      ],
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "description": "The directory from which to export the instance data. Defaults to the current directory",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
+      "args": {}
+    },
     "loader-process:load": {
       "id": "loader-process:load",
       "description": "Upload a csv file and kick off a load job for the uploaded file. The config path must be a reference to a .json or a .yml file.",
@@ -411,21 +523,48 @@
       "examples": [
         "$ contrail types getAll\n"
       ],
-      "flags": {},
+      "flags": {
+        "outDir": {
+          "name": "outDir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory to which to export the type data. Defaults to the current directory",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        },
+        "overwrite": {
+          "name": "overwrite",
+          "type": "boolean",
+          "description": "Replaces any existing export files in outDir",
+          "required": false,
+          "allowNo": false
+        }
+      },
       "args": {}
     },
     "types:loadAll": {
       "id": "types:loadAll",
-      "description": "Get all Types and associated data for your Org",
+      "description": "loads all the type data that has been exported by getAll",
       "strict": true,
       "pluginName": "@contrail/cli",
       "pluginAlias": "@contrail/cli",
       "pluginType": "core",
       "aliases": [],
       "examples": [
-        "$ contrail types getAll\n"
+        "$ contrail types loadAll\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to load the types data. Defaults to the current directory.",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:mergeOptionSets": {
@@ -636,7 +775,7 @@
     },
     "types:uploadOptionSetHierarchies": {
       "id": "types:uploadOptionSetHierarchies",
-      "description": "Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.",
+      "description": "Upload Option Set Hierarchies for your Org. Option set hierarchies are loaded from .yml files in the option-set-hierarchies directory.",
       "strict": true,
       "pluginName": "@contrail/cli",
       "pluginAlias": "@contrail/cli",
@@ -645,7 +784,17 @@
       "examples": [
         "$ contrail types uploadOptionSetHierarchies\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the option set hierarchies data. Defaults to the current directory. The option set data will be loaded from $dir/option-set-hierarchies",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:uploadOptionSets": {
@@ -659,7 +808,17 @@
       "examples": [
         "$ contrail types uploadOptionSets\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the option set data. Defaults to the current directory. The option set data will be loaded from $dir/option-sets",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:uploadOptionSetsHierarchyLocalFile": {
@@ -698,7 +857,17 @@
       "examples": [
         "$ contrail types uploadRuleSets\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the rule set data. Defaults to the current directory. The rule set data will be loaded from $dir/rule-sets/*.yml",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:uploadTypePropertyPolicies": {
@@ -712,7 +881,17 @@
       "examples": [
         "$ contrail types uploadTypePropertyPolicies\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the type property policy data. Defaults to the current directory. The type property policy data will be loaded from $dir/type-property-policies/*.yml",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:uploadUsageInfo": {
@@ -726,7 +905,17 @@
       "examples": [
         "$ contrail types uploadUsageInfo\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the usage info data. Defaults to the current directory. The option set data will be loaded from $dir/usage-info.yml",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "users:export": {
@@ -741,13 +930,21 @@
         "$ contrail users export\n"
       ],
       "flags": {
-        "fileOut": {
-          "name": "fileOut",
+        "outDir": {
+          "name": "outDir",
           "type": "option",
-          "char": "f",
+          "char": "d",
           "description": "The location for the file to be saved",
           "required": false,
-          "multiple": false
+          "multiple": false,
+          "default": "users.yml"
+        },
+        "overwrite": {
+          "name": "overwrite",
+          "type": "boolean",
+          "description": "Replaces existing files if they exist",
+          "required": false,
+          "allowNo": false
         }
       },
       "args": {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",
@@ -26,6 +26,7 @@
     "@contrail/types": "^3.0.20",
     "@contrail/util": "^1.0.17",
     "@oclif/core": "^2",
+    "@oclif/plugin-autocomplete": "^2.1.4",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^2.3.2",
     "@typescript-eslint/eslint-plugin": "^5.54.1",
@@ -64,12 +65,13 @@
     "typescript": "^4.9.5"
   },
   "oclif": {
-    "bin": "contrail-cli",
+    "bin": "contrail",
     "dirname": "contrail-cli",
     "commands": "./dist/commands",
     "plugins": [
       "@oclif/plugin-help",
-      "@oclif/plugin-plugins"
+      "@oclif/plugin-plugins",
+      "@oclif/plugin-autocomplete"
     ],
     "topicSeparator": " ",
     "topics": {
@@ -96,6 +98,9 @@
       },
       "workflow-templates": {
         "description": "Manage workflow templates"
+      },
+      "instance": {
+        "description": "Manage instance (org) configuration data"
       }
     }
   },