prodlysfcli 1.2.0 → 1.2.1

package/oclif.manifest.json

@@ -1,4 +1,702 @@
 {
-  "commands": {},
-  "version": "1.2.0"
+  "commands": {
+    "prodly:checkin": {
+      "aliases": [],
+      "args": {},
+      "description": "Save data from a Salesforce environment to a VCS repository branch.",
+      "examples": [
+        "<%= config.bin %> prodly:checkin --target-org test-utxac7gbati9@example.com --target-dev-hub jsmith@acme.com\nSave managed data to the branch associated with the managed instance identified by the target username.\nThe instance should be managed by the Prodly account associated with the provided DevHub control org.",
+        "<%= config.bin %> prodly:checkin -u test-utxac7gbati9@example.com\nSave managed data to the branch associated with the managed instance identified by the target username.\nThe instance should be managed by the Prodly account associated with the default DevHub control org.",
+        "<%= config.bin %> prodly:checkin -i f50616b6-57b1-4941-802f-ee0e2506f217\nSave managed data to the branch associated with the managed instance identified by the provided ID.\nThe instance should be managed by the Prodly account associated with the default DevHub control org."
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "branch": {
+          "char": "b",
+          "name": "branch",
+          "summary": "branch name for deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "comment": {
+          "char": "c",
+          "name": "comment",
+          "required": true,
+          "summary": "comment for the command versioning commit",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dataset": {
+          "char": "t",
+          "name": "dataset",
+          "summary": "name or record ID of the data set to deploy",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "filter": {
+          "char": "q",
+          "name": "filter",
+          "summary": "query filter override for a data set deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "instance": {
+          "char": "i",
+          "name": "instance",
+          "summary": "managed instance ID on which to perform the action",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "notes": {
+          "char": "z",
+          "name": "notes",
+          "summary": "notes for the deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "plan": {
+          "char": "p",
+          "name": "plan",
+          "summary": "name or record ID of the deployment plan to deploy",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "prodly:checkin",
+      "pluginAlias": "prodlysfcli",
+      "pluginName": "prodlysfcli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "prodly:checkin command",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "prodly",
+        "checkin.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "prodly:checkin",
+        "checkin:prodly"
+      ]
+    },
+    "prodly:checkout": {
+      "aliases": [],
+      "args": {},
+      "description": "Deploy data from a VCS repository branch to a Salesforce environment.",
+      "examples": [
+        "<%= config.bin %> prodly:checkout --target-org test-utxac7gbati9@example.com --target-dev-hub jsmith@acme.com\nDeploy managed data to the managed instance identified by the target org from the associated branch.\nThe instance should be managed by the Prodly account associated with the provided DevHub control org.",
+        "<%= config.bin %> prodly:checkout -u test-utxac7gbati9@example.com\nDeploy managed data to the managed instance org identified by the target username from the associated branch.\nThe instance should be managed by the Prodly account associated with the default DevHub control org.",
+        "<%= config.bin %> prodly:checkout -i f50616b6-57b1-4941-802f-ee0e2506f217\nDeploy managed data to the managed instance org from the associated branch.\nThe instance should be managed by the Prodly account associated with the default DevHub control org."
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "branch": {
+          "char": "b",
+          "name": "branch",
+          "summary": "branch name for deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dataset": {
+          "char": "t",
+          "name": "dataset",
+          "summary": "name or record ID of the data set to deploy",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "deactivate": {
+          "char": "e",
+          "name": "deactivate",
+          "summary": "deactivate all events for the deployment",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "filter": {
+          "char": "q",
+          "name": "filter",
+          "summary": "query filter override for a data set deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "instance": {
+          "char": "i",
+          "name": "instance",
+          "summary": "managed instance ID on which to perform the action",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "name": {
+          "char": "n",
+          "name": "name",
+          "summary": "name for the deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "notes": {
+          "char": "z",
+          "name": "notes",
+          "summary": "notes for the deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "plan": {
+          "char": "p",
+          "name": "plan",
+          "summary": "name or record ID of the deployment plan to deploy",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "prodly:checkout",
+      "pluginAlias": "prodlysfcli",
+      "pluginName": "prodlysfcli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "prodly:checkout command",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "prodly",
+        "checkout.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "prodly:checkout",
+        "checkout:prodly"
+      ]
+    },
+    "prodly:deploy": {
+      "aliases": [],
+      "args": {},
+      "description": "Deploy data from one Salesforce environment directly to another Salesforce environment.",
+      "examples": [
+        "<%= config.bin %> prodly:deploy -n scratchorg -u FixesScratchOrg -v MainDevHub\nCommand output... deploying from the dev hub, the control org, to the scratch org, auto managed with provided name.",
+        "<%= config.bin %> prodly:deploy --target-org test-utxac7gbati9@example.com --target-dev-hub jsmith@acme.com\nCommand output... deploying from the dev hub, the control org, to the scratch org. Long param names.",
+        "<%= config.bin %> prodly:deploy -u test-utxac7gbati9@example.com -v jsmith@acme.com -d \"UAT Sandbox Connection\"\nCommand output... deploying from the scratch org to the UAT sandbox, using the named connection record in the dev hub, control org.",
+        "<%= config.bin %> prodly:deploy --target-org test-utxac7gbati9@example.com --target-dev-hub jsmith@acme.com --source \"UAT Sandbox Connection\"\nCommand output... deploying to the scratch org from the UAT sandbox, using the named connection record in the dev hub, control org. Long param names."
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "dataset": {
+          "char": "t",
+          "name": "dataset",
+          "summary": "name or record ID of the data set to deploy",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "deactivate": {
+          "char": "e",
+          "name": "deactivate",
+          "summary": "deactivate all events for the deployment",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "destination": {
+          "char": "d",
+          "name": "destination",
+          "summary": "destination managed instance ID",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "filter": {
+          "char": "q",
+          "name": "filter",
+          "summary": "query filter override for a data set deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "label": {
+          "char": "b",
+          "name": "label",
+          "summary": "connection and managed instance name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "name": {
+          "char": "n",
+          "name": "name",
+          "summary": "name for the deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "notes": {
+          "char": "z",
+          "name": "notes",
+          "summary": "notes for the deployment",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "plan": {
+          "char": "p",
+          "name": "plan",
+          "summary": "name or record ID of the deployment plan to deploy",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "simulation": {
+          "char": "l",
+          "name": "simulation",
+          "summary": "perform a data simulation",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "source": {
+          "char": "s",
+          "name": "source",
+          "summary": "source managed instance ID",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "prodly:deploy",
+      "pluginAlias": "prodlysfcli",
+      "pluginName": "prodlysfcli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "prodly:deploy command",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "prodly",
+        "deploy.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "prodly:deploy",
+        "deploy:prodly"
+      ]
+    },
+    "prodly:jobs": {
+      "aliases": [],
+      "args": {},
+      "description": " Check the job status.",
+      "examples": [
+        "<%= config.bin %> prodly:jobs -j jobId -v MainDevHub\nPrint the job status for the provided job Id."
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "job": {
+          "char": "j",
+          "name": "job",
+          "required": true,
+          "summary": "Prodly Job ID",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "prodly:jobs",
+      "pluginAlias": "prodlysfcli",
+      "pluginName": "prodlysfcli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "prodly:jobs command",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "prodly",
+        "jobs.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "prodly:jobs",
+        "jobs:prodly"
+      ]
+    },
+    "prodly:manage": {
+      "aliases": [],
+      "args": {},
+      "description": "Authorize (or unauthorize) a Salesforce environment (not already added to the Environments page in Release tab) for use by the plugin.",
+      "examples": [
+        "<%= config.bin %> prodly:manage -l -p\nList and print all of the managed instances for the Prodly account associated with the default DevHub control org.",
+        "<%= config.bin %> prodly:manage -m --target-org test-utxac7gbati9@example.com --target-dev-hub jsmith@acme.com\nManage the org associated with the target username under the Prodly account associated with the provided DevHub control org.",
+        "<%= config.bin %> prodly:manage -m -u test-utxac7gbati9@example.com -n dev7sbx\nManage and version the org associated with the target username under the Prodly account associated with the default DevHub control org."
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "comment": {
+          "char": "c",
+          "name": "comment",
+          "summary": "comment for the command versioning commit",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "connection": {
+          "char": "n",
+          "name": "connection",
+          "summary": "connection to use for the managed instance",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "instance": {
+          "char": "i",
+          "name": "instance",
+          "summary": "managed instance ID on which to perform the action",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "label": {
+          "char": "b",
+          "name": "label",
+          "summary": "connection and managed instance name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "list": {
+          "char": "l",
+          "name": "list",
+          "summary": "list all managed instances",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "manage": {
+          "char": "m",
+          "name": "manage",
+          "summary": "manage a new instance",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "print": {
+          "char": "p",
+          "name": "print",
+          "summary": "print the managed instances in a standard format in addition to returning structured data",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "unmanage": {
+          "char": "x",
+          "name": "unmanage",
+          "summary": "unmanage the specified instance",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "version": {
+          "char": "s",
+          "name": "version",
+          "summary": "version the new managed instance, branch created and data deployed to the org",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "prodly:manage",
+      "pluginAlias": "prodlysfcli",
+      "pluginName": "prodlysfcli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "prodly:manage command",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "prodly",
+        "manage.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "prodly:manage",
+        "manage:prodly"
+      ]
+    },
+    "prodly:version": {
+      "aliases": [],
+      "args": {},
+      "description": "Adds version control to a managed environment.",
+      "examples": [
+        "<%= config.bin %> prodly:version -s main\nAdd version control to the managed instance identified by the target org. Use the \"main\" branch.\nThe instance should be managed by the Prodly account associated with the default DevHub control org.",
+        "<%= config.bin %> prodly:version -s main -b cli-branch -i f50616b6-57b1-4941-802f-ee0e2506f217\nAdd version control to the managed instance identified by the provided ID. Use the \"main\" branch as a base for a new branch called \"cli-branch\"\nThe instance should be managed by the Prodly account associated with the default DevHub control org."
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "new-branch": {
+          "char": "b",
+          "name": "new-branch",
+          "required": false,
+          "summary": "if provided it creates a new branch based on the source branch that will be used for version control",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "source-branch": {
+          "char": "s",
+          "name": "source-branch",
+          "required": true,
+          "summary": "the version control branch or the base for the new branch (if provided)",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "instance": {
+          "char": "i",
+          "name": "instance",
+          "required": false,
+          "summary": "managed instance ID on which to perform the action",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "prodly:version",
+      "pluginAlias": "prodlysfcli",
+      "pluginName": "prodlysfcli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "prodly:version command",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "prodly",
+        "version.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "prodly:version",
+        "version:prodly"
+      ]
+    }
+  },
+  "version": "1.2.1"
 }