@jayree/sfdx-plugin-manifest
Version:
A Salesforce CLI plugin containing commands for creating manifest files from Salesforce orgs or git commits of sfdx projects.
271 lines • 10 kB
JSON
{
"commands": {
"jayree:manifest:cleanup": {
"aliases": [],
"args": {},
"description": "Use this command to remove components or metadata types from a manifes file.\n\nIf the 'cleanup' manifest file (--file) doesn't exist, a template file is created, which can then be modified.",
"examples": [
"<%= config.bin %> <%= command.id %> --manifest=package.xml --file=packageignore.xml"
],
"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"
},
"manifest": {
"char": "x",
"name": "manifest",
"summary": "Path to the manifest file.",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"file": {
"char": "f",
"name": "file",
"required": true,
"summary": "Path to the second 'cleanup' manifest file.",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "jayree:manifest:cleanup",
"pluginAlias": "@jayree/sfdx-plugin-manifest",
"pluginName": "@jayree/sfdx-plugin-manifest",
"pluginType": "core",
"strict": true,
"summary": "Removes those tags from a manifest file that are present in a second manifest file.",
"enableJsonFlag": true,
"requiresProject": true,
"isESM": true,
"relativePath": [
"lib",
"commands",
"jayree",
"manifest",
"cleanup.js"
]
},
"jayree:manifest:generate": {
"aliases": [],
"args": {},
"description": "Use this command to generate a manifest file based on an existing org.",
"examples": [
"<%= config.bin %> <%= command.id %> --targetusername myOrg@example.com\n\n<?xml version='1.0' encoding='UTF-8'?>\n\n<Package xmlns='http://soap.sforce.com/2006/04/metadata'>...</Package>"
],
"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-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"
},
"api-version": {
"description": "Override the api version used for api requests made by this command",
"name": "api-version",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"quick-filter": {
"char": "q",
"name": "quick-filter",
"summary": "Metadata type, member or file path to filter on.",
"hasDynamicHelp": false,
"multiple": true,
"type": "option"
},
"match-case": {
"char": "c",
"name": "match-case",
"summary": "Enable 'match case' for the quickfilter.",
"allowNo": false,
"type": "boolean"
},
"match-whole-word": {
"char": "w",
"name": "match-whole-word",
"summary": "Enable 'match whole word' for the quickfilter.",
"allowNo": false,
"type": "boolean"
},
"include-flow-versions": {
"name": "include-flow-versions",
"summary": "Include flow versions as with api version 43.0.",
"allowNo": false,
"type": "boolean"
},
"file": {
"char": "f",
"name": "file",
"summary": "Write to 'file' instead of stdout.",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"exclude-managed": {
"char": "x",
"exclusive": [
"exclude-all"
],
"name": "exclude-managed",
"summary": "Exclude managed packages from output.",
"allowNo": false,
"type": "boolean"
},
"exclude-all": {
"char": "a",
"exclusive": [
"exclude-managed"
],
"name": "exclude-all",
"summary": "Exclude all packages from output.",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": true,
"hiddenAliases": [],
"id": "jayree:manifest:generate",
"pluginAlias": "@jayree/sfdx-plugin-manifest",
"pluginName": "@jayree/sfdx-plugin-manifest",
"pluginType": "core",
"strict": true,
"summary": "Generate a complete manifest file form the specified org.",
"enableJsonFlag": true,
"isESM": true,
"relativePath": [
"lib",
"commands",
"jayree",
"manifest",
"generate.js"
]
},
"jayree:manifest:git:diff": {
"aliases": [],
"args": {
"ref1": {
"description": "Base commit or branch.",
"name": "ref1",
"required": true
},
"ref2": {
"description": "Commit or branch to compare to the base commit.",
"name": "ref2"
}
},
"description": "Use this command to create a manifest and destructiveChanges manifest file based on the difference (git diff) of two git refs.\n\nYou can use all ways to spell <commit> which are valid for 'git diff' (See https://git-scm.com/docs/git-diff).",
"examples": [
"Uses the changes between two arbitrary <commit>.\n<%= config.bin %> <%= command.id %> <commit> <commit>\n<%= config.bin %> <%= command.id %> <commit>..<commit>",
"Uses the changes on the branch containing and up to the second <commit>, starting at a common ancestor of both <commit>.\n<%= config.bin %> <%= command.id %> <commit>...<commit>",
"Uses the diff of what is unique in branchB (REF2) and unique in branchA (REF1).\n<%= config.bin %> <%= command.id %> branchA..branchB",
"Uses the diff of what is unique in branchB (REF2).\n<%= config.bin %> <%= command.id %> branchA...branchB",
"Specify the flags before or after the REF args\n<%= config.bin %> <%= command.id %> --output-dir package <commit> <commit>\n<%= config.bin %> <%= command.id %> <commit> <commit> --output-dir package",
"If you specify the 'source-dir' flag before the REF args, use '--' to separate the args from the 'source-dir' values.\n<%= config.bin %> <%= command.id %> --source-dir force-app -- <commit> <commit>"
],
"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"
},
"api-version": {
"description": "Override the api version used for api requests made by this command",
"name": "api-version",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"source-dir": {
"char": "d",
"description": "The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its subdirectories).\n\nYou can specify this flag more than once.",
"name": "source-dir",
"summary": "Path to the local source files to include in the manifest.",
"hasDynamicHelp": false,
"multiple": true,
"type": "option"
},
"output-dir": {
"char": "r",
"description": "The location can be an absolute path or relative to the current working directory.",
"name": "output-dir",
"summary": "Directory to save the created manifest files.",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"destructive-changes-only": {
"description": "Use this flag to create a 'destructiveChanges.xml' and a blank 'package.xml'.",
"name": "destructive-changes-only",
"summary": "Create a destructiveChanges manifest only.",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "jayree:manifest:git:diff",
"pluginAlias": "@jayree/sfdx-plugin-manifest",
"pluginName": "@jayree/sfdx-plugin-manifest",
"pluginType": "core",
"strict": true,
"summary": "Create a project manifest and destructiveChanges manifest that lists the metadata components you want to deploy or delete based on changes in your git history.",
"enableJsonFlag": true,
"requiresProject": true,
"isESM": true,
"relativePath": [
"lib",
"commands",
"jayree",
"manifest",
"git",
"diff.js"
]
}
},
"version": "4.0.26"
}