# sfdx-jayree A Salesforce CLI plugin containing commands and hooks for Salesforce Application Lifecycle Management tasks. [![sfdx](https://img.shields.io/badge/cli-sfdx-brightgreen.svg)](https://developer.salesforce.com/tools/sfdxcli) [![Version](https://img.shields.io/npm/v/sfdx-jayree.svg)](https://npmjs.org/package/sfdx-jayree) [![test-and-release](https://github.com/jayree/sfdx-jayree-plugin/actions/workflows/release.yml/badge.svg)](https://github.com/jayree/sfdx-jayree-plugin/actions/workflows/release.yml) [![Downloads/week](https://img.shields.io/npm/dw/sfdx-jayree.svg)](https://npmjs.org/package/sfdx-jayree) [![License](https://img.shields.io/npm/l/sfdx-jayree.svg)](https://github.com/jayree/sfdx-jayree-plugin/blob/main/package.json) [![Gitter](https://badges.gitter.im/sfdx-jayree-plugin/community.svg)](https://gitter.im/sfdx-jayree-plugin/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ## Install ```bash sf plugins install sfdx-jayree ``` ## Commands * [`sfdx jayree flow get coverage`](#sfdx-jayree-flow-get-coverage) * [`sfdx jayree manifest cleanup`](#sfdx-jayree-manifest-cleanup) * [`sfdx jayree manifest generate`](#sfdx-jayree-manifest-generate) * [`sfdx jayree manifest git diff REF1 [REF2]`](#sfdx-jayree-manifest-git-diff-ref1-ref2) * [`sfdx jayree org configure`](#sfdx-jayree-org-configure) * [`sfdx jayree org configure country`](#sfdx-jayree-org-configure-country) * [`sfdx jayree org configure state`](#sfdx-jayree-org-configure-state) * [`sfdx jayree org get settings`](#sfdx-jayree-org-get-settings) * [`sfdx jayree org stream`](#sfdx-jayree-org-stream) * [`sfdx jayree project compare snapshot`](#sfdx-jayree-project-compare-snapshot) * [`sfdx jayree project fix`](#sfdx-jayree-project-fix) * [`sfdx jayree project generate snapshot`](#sfdx-jayree-project-generate-snapshot) * [`sfdx jayree project list tracking`](#sfdx-jayree-project-list-tracking) * [`sfdx jayree project store tracking get`](#sfdx-jayree-project-store-tracking-get) * [`sfdx jayree project store tracking set`](#sfdx-jayree-project-store-tracking-set) ### `sfdx jayree flow get coverage` Check the flow test coverage of an Org. ``` USAGE $ sfdx jayree flow get coverage -o [--json] [--flags-dir ] [--api-version ] FLAGS -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. --api-version= Override the api version used for api requests made by this command GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ALIASES $ sfdx jayree flowtestcoverage EXAMPLES $ sfdx jayree:flowtestcoverage === Flow Test Coverage Coverage: 82% ... ``` _See code: [@jayree/sfdx-plugin-org](https://github.com/jayree/sfdx-plugin-org/blob/v1.2.172/src/commands/jayree/flow/get/coverage.ts)_ ### `sfdx jayree manifest cleanup` Removes those tags from a manifest file that are present in a second manifest file. ``` USAGE $ sfdx jayree manifest cleanup -f [--json] [--flags-dir ] [-x ] FLAGS -f, --file= (required) Path to the second 'cleanup' manifest file. -x, --manifest= Path to the manifest file. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. DESCRIPTION Removes those tags from a manifest file that are present in a second manifest file. Use this command to remove components or metadata types from a manifes file. If the 'cleanup' manifest file (--file) doesn't exist, a template file is created, which can then be modified. EXAMPLES $ sfdx jayree manifest cleanup --manifest=package.xml --file=packageignore.xml ``` _See code: [@jayree/sfdx-plugin-manifest](https://github.com/jayree/sfdx-plugin-manifest/blob/v4.0.128/src/commands/jayree/manifest/cleanup.ts)_ ### `sfdx jayree manifest generate` Generate a complete manifest file form the specified org. ``` USAGE $ sfdx jayree manifest generate -o [--json] [--flags-dir ] [--api-version ] [-q ...] [-c] [-w] [--include-flow-versions] [-f ] [-x | -a] FLAGS -a, --exclude-all Exclude all packages from output. -c, --match-case Enable 'match case' for the quickfilter. -f, --file= Write to 'file' instead of stdout. -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. -q, --quick-filter=... Metadata type, member or file path to filter on. -w, --match-whole-word Enable 'match whole word' for the quickfilter. -x, --exclude-managed Exclude managed packages from output. --api-version= Override the api version used for api requests made by this command --include-flow-versions Include flow versions as with api version 43.0. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. DESCRIPTION Generate a complete manifest file form the specified org. Use this command to generate a manifest file based on an existing org. EXAMPLES $ sfdx jayree manifest generate --targetusername myOrg@example.com ... ``` _See code: [@jayree/sfdx-plugin-manifest](https://github.com/jayree/sfdx-plugin-manifest/blob/v4.0.128/src/commands/jayree/manifest/generate.ts)_ ### `sfdx jayree manifest git diff REF1 [REF2]` 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. ``` USAGE $ sfdx jayree manifest git diff REF1 [REF2] [--json] [--flags-dir ] [--api-version ] [-d ...] [-r ] [--destructive-changes-only] ARGUMENTS REF1 Base commit or branch. [REF2] Commit or branch to compare to the base commit. FLAGS -d, --source-dir=... Path to the local source files to include in the manifest. -r, --output-dir= Directory to save the created manifest files. --api-version= Override the api version used for api requests made by this command --destructive-changes-only Create a destructiveChanges manifest only. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. DESCRIPTION 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. Use this command to create a manifest and destructiveChanges manifest file based on the difference (git diff) of two git refs. You can use all ways to spell which are valid for 'git diff' (See https://git-scm.com/docs/git-diff). EXAMPLES Uses the changes between two arbitrary . $ sfdx jayree manifest git diff $ sfdx jayree manifest git diff .. Uses the changes on the branch containing and up to the second , starting at a common ancestor of both . $ sfdx jayree manifest git diff ... Uses the diff of what is unique in branchB (REF2) and unique in branchA (REF1). $ sfdx jayree manifest git diff branchA..branchB Uses the diff of what is unique in branchB (REF2). $ sfdx jayree manifest git diff branchA...branchB Specify the flags before or after the REF args $ sfdx jayree manifest git diff --output-dir package $ sfdx jayree manifest git diff --output-dir package If you specify the 'source-dir' flag before the REF args, use '--' to separate the args from the 'source-dir' values. $ sfdx jayree manifest git diff --source-dir force-app -- FLAG DESCRIPTIONS -d, --source-dir=... Path to the local source files to include in the manifest. 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). You can specify this flag more than once. -r, --output-dir= Directory to save the created manifest files. The location can be an absolute path or relative to the current working directory. --destructive-changes-only Create a destructiveChanges manifest only. Use this flag to create a 'destructiveChanges.xml' and a blank 'package.xml'. ``` _See code: [@jayree/sfdx-plugin-manifest](https://github.com/jayree/sfdx-plugin-manifest/blob/v4.0.128/src/commands/jayree/manifest/git/diff.ts)_ ### `sfdx jayree org configure` Make configuration changes that are not covered by the metadata API. ``` USAGE $ sfdx jayree org configure -o [--json] [--flags-dir ] [--api-version ] [-t ...] [--concurrent] FLAGS -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. -t, --tasks=... Task name(s) listed in sfdx-project.json, if no tasks are specified, all tasks marked as active will be executed. --api-version= Override the api version used for api requests made by this command --concurrent Execute tasks in parallel. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. EXAMPLES $ sfdx jayree:org:configure $ sfdx jayree:org:configure -u me@my.org $ sfdx jayree:org:configure --tasks="Asset Settings","Activity Settings" $ sfdx jayree:org:configure --concurrent --tasks="Asset Settings","Activity Settings" ``` _See code: [@jayree/sfdx-plugin-org](https://github.com/jayree/sfdx-plugin-org/blob/v1.2.172/src/commands/jayree/org/configure/index.ts)_ ### `sfdx jayree org configure country` update country integration values in the State/Country Picklists ``` USAGE $ sfdx jayree org configure country -o [--json] [--flags-dir ] [--api-version ] FLAGS -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. --api-version= Override the api version used for api requests made by this command GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ``` _See code: [@jayree/sfdx-plugin-org](https://github.com/jayree/sfdx-plugin-org/blob/v1.2.172/src/commands/jayree/org/configure/country.ts)_ ### `sfdx jayree org configure state` import (create/update) states into the State/Country Picklists ``` USAGE $ sfdx jayree org configure state -o [--json] [--flags-dir ] [--api-version ] [--country-code ] [--category ] [--language ] [--concurrent ] FLAGS -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. --api-version= Override the api version used for api requests made by this command --category= Subdivision category. --concurrent= [default: 1] execute tasks in parallel. --country-code= Alpha-2 code. --language= Language code. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ``` _See code: [@jayree/sfdx-plugin-org](https://github.com/jayree/sfdx-plugin-org/blob/v1.2.172/src/commands/jayree/org/configure/state.ts)_ ### `sfdx jayree org get settings` Write the current settings from an Org to a scratch org def file. ``` USAGE $ sfdx jayree org get settings -o [--json] [--flags-dir ] [--api-version ] [-w] [-f ] FLAGS -f, --file= Write to 'file' instead of project-scratch-def.json. -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. -w, --writetoprojectscratchdeffile Write output to project-scratch-def.json file. --api-version= Override the api version used for api requests made by this command GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ALIASES $ sfdx jayree org settings EXAMPLES $ sfdx jayree:org:settings $ sfdx jayree:org:settings -u me@my.org $ sfdx jayree:org:settings -u MyTestOrg1 -w ``` _See code: [@jayree/sfdx-plugin-org](https://github.com/jayree/sfdx-plugin-org/blob/v1.2.172/src/commands/jayree/org/get/settings.ts)_ ### `sfdx jayree org stream` Listen to streaming api and platform events. ``` USAGE $ sfdx jayree org stream -o -c [--json] [--flags-dir ] [--api-version ] [-r ] FLAGS -c, --channel= (required) The event name. -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. -r, --replay-id= Receive all stored events after the event specified by the replayId value and new events. [default: -1] Receive new events that are broadcast after the command subscribes. [-2] Receive all event, including past events that are within the retention window and new events. --api-version= Override the api version used for api requests made by this command GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ALIASES $ sfdx jayree org streaming EXAMPLES $ sfdx jayree org stream --channel=/event/eventName__e ... ``` _See code: [@jayree/sfdx-plugin-org](https://github.com/jayree/sfdx-plugin-org/blob/v1.2.172/src/commands/jayree/org/stream.ts)_ ### `sfdx jayree project compare snapshot` Compare sfdx source snapshot files. ``` USAGE $ sfdx jayree project compare snapshot [--json] [--flags-dir ] [--filepath ] FLAGS --filepath= [default: ./sfdx-source-snapshot.json] Path of the generated snapshot file. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ALIASES $ sfdx jayree source snapshot compare ``` _See code: [@jayree/sfdx-plugin-source](https://github.com/jayree/sfdx-plugin-source/blob/v1.3.168/src/commands/jayree/project/compare/snapshot.ts)_ ### `sfdx jayree project fix` Fix retrieved metadata. ``` USAGE $ sfdx jayree project fix [--json] [--flags-dir ] [-o ] [-t ...] FLAGS -o, --target-org= Username or alias of the target org. -t, --task=... Task name(s) listed in sfdx-project.json. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ALIASES $ sfdx jayree source fix ``` _See code: [@jayree/sfdx-plugin-source](https://github.com/jayree/sfdx-plugin-source/blob/v1.3.168/src/commands/jayree/project/fix.ts)_ ### `sfdx jayree project generate snapshot` Generate sfdx source snapshot files. ``` USAGE $ sfdx jayree project generate snapshot [--json] [--flags-dir ] [--filepath ] FLAGS --filepath= [default: ./sfdx-source-snapshot.json] Path to save the generated snapshot file. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ALIASES $ sfdx jayree source snapshot generate ``` _See code: [@jayree/sfdx-plugin-source](https://github.com/jayree/sfdx-plugin-source/blob/v1.3.168/src/commands/jayree/project/generate/snapshot.ts)_ ### `sfdx jayree project list tracking` List changes in a scratch org by remote revision counter number. ``` USAGE $ sfdx jayree project list tracking -o [--json] [--flags-dir ] [--api-version ] [-r ] FLAGS -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. -r, --revision= Start at a specific revision counter number. --api-version= Override the api version used for api requests made by this command GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ALIASES $ sfdx jayree source tracking list EXAMPLES $ sfdx jayree:source:tracking:list $ sfdx jayree:source:tracking:list -u me@my.org $ sfdx jayree:source:tracking:list -u me@my.org -r 101 ``` _See code: [@jayree/sfdx-plugin-source](https://github.com/jayree/sfdx-plugin-source/blob/v1.3.168/src/commands/jayree/project/list/tracking.ts)_ ### `sfdx jayree project store tracking get` Get stored revision counter number. ``` USAGE $ sfdx jayree project store tracking get -o [--json] [--flags-dir ] FLAGS -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ALIASES $ sfdx jayree source tracking store get EXAMPLES $ sfdx jayree:source:tracking:store:get $ sfdx jayree:source:tracking:store:get -u me@my.org ``` _See code: [@jayree/sfdx-plugin-source](https://github.com/jayree/sfdx-plugin-source/blob/v1.3.168/src/commands/jayree/project/store/tracking/get.ts)_ ### `sfdx jayree project store tracking set` Store revision counter number. ``` USAGE $ sfdx jayree project store tracking set -o [--json] [--flags-dir ] [--api-version ] [-r ] FLAGS -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` configuration variable is already set. -r, --revision= Revision counter number (default: remote revision counter number). --api-version= Override the api version used for api requests made by this command GLOBAL FLAGS --flags-dir= Import flag values from a directory. --json Format output as json. ALIASES $ sfdx jayree source tracking store set EXAMPLES $ sfdx jayree:source:tracking:store:set $ sfdx jayree:source:tracking:store:set -u me@my.org $ sfdx jayree:source:tracking:store:set -u MyTestOrg1 -r 101 ``` _See code: [@jayree/sfdx-plugin-source](https://github.com/jayree/sfdx-plugin-source/blob/v1.3.168/src/commands/jayree/project/store/tracking/set.ts)_ ## Hooks ### prerun - Resets source tracking using `force:source:tracking:reset` before executing `force:source:pull` or `project:retrieve:start`. > **_IMPORTANT:_** This hook will only run if `SFDX_ENABLE_JAYREE_HOOKS_RESET_BEFORE_PULL=true` is set. It uses the stored `serverMaxRevisionCounter` as revision counter number (see: [`jayree:project:store:tracking:set`](#sfdx-jayreeprojectstoretrackingset)). If the hook doesn't find a stored value it asks if the current *local* revision counter number should be stored and used. ### scopedPreRetrieve - Disables the `prettierFormat` hook. See [sfdx-plugin-prettier](https://github.com/jayree/sfdx-plugin-prettier) for more details. ### scopedPostRetrieve - Applies source fixes of the `jayree project fix` command, deletes and moves source files to separate package directories. See the configuration file [sfdx-project.json](https://github.com/jayree/sfdx-plugin-source/blob/main/sfdx-project.json) for examples. Set `"isActive": true`, to apply this fix during `scopedPostRetrieve` hook. > **_IMPORTANT:_** Since the hook is not able to update the (JSON) output of the command, an additional output is generated. Set the environment variable `SFDX_ENABLE_JAYREE_HOOKS_JSON_OUTPUT=true` and additional comma-separated JSON output will be appended, where the output must be parsed as an array, e.g. ``JSON.parse(`[${stdout}]`)``. See an example below: ```javascript import execa from "execa"; import { CliUx } from "@oclif/core"; async function run() { const { stdout } = await execa("sfdx", [ "force:source:retrieve", "--metadata", "Group:*", "--json" ]); const parsedStdout = JSON.parse(`[${stdout}]`); CliUx.ux.styledJSON( parsedStdout.length > 1 ? { ...parsedStdout[0], result: { ...parsedStdout[0].result, fixedFiles: parsedStdout[1].fixedFiles } } : parsedStdout[0] ); } run(); ``` - Calls `prettierFormat` hook. See [sfdx-plugin-prettier](https://github.com/jayree/sfdx-plugin-prettier) for more details.