sf-decomposer/oclif.manifest.json

Break down large Salesforce metadata files into smaller, more manageable files for version control and then recreate deployment-compatible files.

{
  "commands": {
    "decomposer:decompose": {
      "aliases": [],
      "args": {},
      "description": "Decompose large metadata files into smaller files.\n\nYou should run this after you retrieve metadata from an org.",
      "examples": [
        "`sf decomposer decompose -m \"flow\" -f \"xml\" --prepurge --postpurge --debug`",
        "`sf decomposer decompose -m \"flow\" -m \"labels\" -f \"xml\" --prepurge --postpurge --debug`",
        "`sf decomposer decompose -m \"flow\" -f \"xml\" -i \"force-app\"`"
      ],
      "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"
        },
        "metadata-type": {
          "char": "m",
          "name": "metadata-type",
          "required": true,
          "summary": "The metadata suffix to process, such as 'flow', 'labels', etc.",
          "hasDynamicHelp": false,
          "multiple": true,
          "type": "option"
        },
        "prepurge": {
          "name": "prepurge",
          "required": false,
          "summary": "Purge directories of pre-existing decomposed files.",
          "allowNo": false,
          "type": "boolean"
        },
        "postpurge": {
          "name": "postpurge",
          "required": false,
          "summary": "Purge the original files after decomposing them.",
          "allowNo": false,
          "type": "boolean"
        },
        "debug": {
          "name": "debug",
          "required": false,
          "summary": "Debug to a log file.",
          "allowNo": false,
          "type": "boolean"
        },
        "format": {
          "char": "f",
          "name": "format",
          "required": true,
          "summary": "File format for the decomposed files.",
          "default": "xml",
          "hasDynamicHelp": false,
          "multiple": false,
          "options": [
            "xml",
            "json",
            "yaml",
            "json5",
            "toml",
            "ini"
          ],
          "type": "option"
        },
        "ignore-package-directory": {
          "char": "i",
          "name": "ignore-package-directory",
          "required": false,
          "summary": "Ignore a package directory.",
          "hasDynamicHelp": false,
          "multiple": true,
          "type": "option"
        },
        "strategy": {
          "char": "s",
          "name": "strategy",
          "required": true,
          "summary": "Strategy to follow when decomposing files.",
          "default": "unique-id",
          "hasDynamicHelp": false,
          "multiple": false,
          "options": [
            "unique-id",
            "grouped-by-tag"
          ],
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "decomposer:decompose",
      "pluginAlias": "sf-decomposer",
      "pluginName": "sf-decomposer",
      "pluginType": "core",
      "strict": true,
      "summary": "Decomposes the metadata files created by retrievals.",
      "enableJsonFlag": true,
      "isESM": true,
      "relativePath": [
        "lib",
        "commands",
        "decomposer",
        "decompose.js"
      ],
      "aliasPermutations": [],
      "permutations": [
        "decomposer:decompose",
        "decompose:decomposer"
      ]
    },
    "decomposer:recompose": {
      "aliases": [],
      "args": {},
      "description": "Recompose the decomposed files into deployment-compatible metadata files.\n\nYou should run this before you deploy decomposed metadata to an org.",
      "examples": [
        "`sf decomposer recompose -m \"flow\" --postpurge --debug`",
        "`sf decomposer recompose -m \"flow\" -i \"force-app\"`"
      ],
      "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"
        },
        "metadata-type": {
          "char": "m",
          "name": "metadata-type",
          "required": true,
          "summary": "The metadata suffix to process, such as 'flow', 'labels', etc.",
          "hasDynamicHelp": false,
          "multiple": true,
          "type": "option"
        },
        "postpurge": {
          "name": "postpurge",
          "required": false,
          "summary": "Purge the decomposed files after recomposing them.",
          "allowNo": false,
          "type": "boolean"
        },
        "debug": {
          "name": "debug",
          "required": false,
          "summary": "Debug to a log file.",
          "allowNo": false,
          "type": "boolean"
        },
        "ignore-package-directory": {
          "char": "i",
          "name": "ignore-package-directory",
          "required": false,
          "summary": "Ignore a package directory.",
          "hasDynamicHelp": false,
          "multiple": true,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "decomposer:recompose",
      "pluginAlias": "sf-decomposer",
      "pluginName": "sf-decomposer",
      "pluginType": "core",
      "strict": true,
      "summary": "Recomposes the files created by the `decompose` command before deployments.",
      "enableJsonFlag": true,
      "isESM": true,
      "relativePath": [
        "lib",
        "commands",
        "decomposer",
        "recompose.js"
      ],
      "aliasPermutations": [],
      "permutations": [
        "decomposer:recompose",
        "recompose:decomposer"
      ]
    }
  },
  "version": "5.8.1"
}