ci-sf-plugin

{ "commands": { "ci:apex:execute": { "aliases": [], "args": {}, "description": "Executes Apex in an org. Either 'pre-push' or 'post-push' flag must be provided.", "examples": [ "sf ci apex execute -o orgAlias --pre-push", "sf ci apex execute --post-push" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" }, "pre-push": { "description": "executes pre-push scripts.", "name": "pre-push", "allowNo": false, "type": "boolean" }, "post-push": { "description": "executes post-push scripts.", "name": "post-push", "allowNo": false, "type": "boolean" }, "ci-config-file": { "char": "x", "description": "path to a 'ciconfig.json' file with 'apexPrePush' or 'apexPostPush' property", "name": "ci-config-file", "default": "ciconfig.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:apex:execute", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "apex", "execute.js" ], "aliasPermutations": [], "permutations": [ "ci:apex:execute", "apex:ci:execute", "apex:execute:ci", "ci:execute:apex", "execute:ci:apex", "execute:apex:ci" ] }, "ci:org:create": { "aliases": [], "args": {}, "description": "Creates a scratch org from your default dev hub. User can be also notified about possibly needed post-org-create manual steps together with instructions how to continue. Different behaviour can be configured for CI environment.", "examples": [ "sf ci org create -a orgAlias", "sf ci org create --set-alias orgAlias --definition-file config/project-scratch-def.json", "sf ci org create --set-alias orgAlias --ci --validation-timeout 60" ], "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": { "aliases": [ "targetdevhubusername" ], "char": "v", "deprecateAliases": true, "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" }, "set-alias": { "char": "a", "description": "alias for the created org", "name": "set-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "duration-days": { "char": "d", "description": "duration of the scratch org (in days) (min:1, max:30)", "name": "duration-days", "default": 30, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "definition-file": { "char": "f", "description": "path to an org definition file", "name": "definition-file", "default": "config/project-scratch-def.json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ci": { "description": "set for CI environment", "name": "ci", "allowNo": false, "type": "boolean" }, "validation-timeout": { "char": "t", "description": "timeout in seconds before org validation happens", "name": "validation-timeout", "default": 30, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ci-config-file": { "char": "x", "description": "path to a 'ciconfig.json' file with 'projectName' property", "name": "ci-config-file", "default": "ciconfig.json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "char": "w", "description": "number of minutes to wait for the scratch org to be ready", "name": "wait", "default": 60, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:org:create", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "org", "create.js" ], "aliasPermutations": [], "permutations": [ "ci:org:create", "org:ci:create", "org:create:ci", "ci:create:org", "create:ci:org", "create:org:ci" ] }, "ci:org:delete": { "aliases": [], "args": {}, "description": "Delete a scratch org. Either explicitly specified org or the default one, if any.", "examples": [ "sf ci org delete -o orgAlias" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:org:delete", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "org", "delete.js" ], "aliasPermutations": [], "permutations": [ "ci:org:delete", "org:ci:delete", "org:delete:ci", "ci:delete:org", "delete:ci:org", "delete:org:ci" ] }, "ci:org:printurl": { "aliases": [], "args": {}, "description": "Display navigation URL for either specified org or the default one, if any, but don’t launch browser.", "examples": [ "sf ci org printurl -o orgAlias" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:org:printurl", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "org", "printurl.js" ], "aliasPermutations": [], "permutations": [ "ci:org:printurl", "org:ci:printurl", "org:printurl:ci", "ci:printurl:org", "printurl:ci:org", "printurl:org:ci" ] }, "ci:package:install": { "aliases": [], "args": {}, "description": "Installs packages into an org.", "examples": [ "sf ci package install -o orgAlias", "sf ci package install --target-org orgAlias --package 04t0W000001MRQIQA4" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" }, "security-type": { "char": "s", "description": "security access type for the installed package", "name": "security-type", "default": "AdminsOnly", "hasDynamicHelp": false, "multiple": false, "options": [ "AllUsers", "AdminsOnly" ], "type": "option" }, "package": { "char": "p", "description": "ID (starts with 04t) or alias of the package version to install, overrides 'ciconfig.json' configuration", "name": "package", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ci-config-file": { "char": "x", "description": "path to a 'ciconfig.json' file with 'packageIds' array property", "name": "ci-config-file", "default": "ciconfig.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:package:install", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "package", "install.js" ], "aliasPermutations": [], "permutations": [ "ci:package:install", "package:ci:install", "package:install:ci", "ci:install:package", "install:ci:package", "install:package:ci" ] }, "ci:source:push": { "aliases": [], "args": {}, "description": "Pushes DX source into an org.", "examples": [ "sf ci source push -o orgAlias", "sf ci source push -o orgAlias --ci" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" }, "ci": { "description": "set for CI environment", "name": "ci", "allowNo": false, "type": "boolean" }, "ci-config-file": { "char": "x", "description": "path to a 'ciconfig.json' file with 'ciForceignore' property", "name": "ci-config-file", "default": "ciconfig.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:source:push", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "ci", "source", "push.js" ], "aliasPermutations": [], "permutations": [ "ci:source:push", "source:ci:push", "source:push:ci", "ci:push:source", "push:ci:source", "push:source:ci" ] }, "ci:source:sort": { "aliases": [], "args": {}, "description": "Sort selected metadata. Profiles, permission sets, muting permission sets and permission set groups are sorted by default.", "examples": [ "sf ci source sort", "sf ci source sort -d '~/projects/project-dx/src/main/default'" ], "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" }, "directory": { "char": "d", "description": "relative path to the parent folder of metadata ('profiles' etc. folders inside)", "name": "directory", "default": "src/main/default", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ci:source:sort", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "source", "sort.js" ], "aliasPermutations": [], "permutations": [ "ci:source:sort", "source:ci:sort", "source:sort:ci", "ci:sort:source", "sort:ci:source", "sort:source:ci" ] }, "ci:apex:test:run": { "aliases": [], "args": {}, "description": "Run unit tests in an org.", "examples": [ "sf ci apex test run -o orgAlias", "sf ci apex test run -o orgAlias --test-level RunLocalTests" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" }, "test-level": { "char": "l", "description": "specifies which tests to run", "name": "test-level", "default": "RunLocalTests", "hasDynamicHelp": false, "multiple": false, "options": [ "RunLocalTests", "RunAllTestsInOrg" ], "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:apex:test:run", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "apex", "test", "run.js" ], "aliasPermutations": [], "permutations": [ "ci:apex:test:run", "apex:ci:test:run", "apex:test:ci:run", "apex:test:run:ci", "ci:test:apex:run", "test:ci:apex:run", "test:apex:ci:run", "test:apex:run:ci", "ci:test:run:apex", "test:ci:run:apex", "test:run:ci:apex", "test:run:apex:ci", "ci:apex:run:test", "apex:ci:run:test", "apex:run:ci:test", "apex:run:test:ci", "ci:run:apex:test", "run:ci:apex:test", "run:apex:ci:test", "run:apex:test:ci", "ci:run:test:apex", "run:ci:test:apex", "run:test:ci:apex", "run:test:apex:ci" ] }, "ci:limits:api:display": { "aliases": [], "args": {}, "description": "Display org's limits.", "examples": [ "sf ci limits api limits -o orgAlias" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:limits:api:display", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "limits", "api", "display.js" ], "aliasPermutations": [], "permutations": [ "ci:limits:api:display", "limits:ci:api:display", "limits:api:ci:display", "limits:api:display:ci", "ci:api:limits:display", "api:ci:limits:display", "api:limits:ci:display", "api:limits:display:ci", "ci:api:display:limits", "api:ci:display:limits", "api:display:ci:limits", "api:display:limits:ci", "ci:limits:display:api", "limits:ci:display:api", "limits:display:ci:api", "limits:display:api:ci", "ci:display:limits:api", "display:ci:limits:api", "display:limits:ci:api", "display:limits:api:ci", "ci:display:api:limits", "display:ci:api:limits", "display:api:ci:limits", "display:api:limits:ci" ] }, "ci:user:assign:permset": { "aliases": [], "args": {}, "description": "Assigns permission sets to an authenticated user.", "examples": [ "sf ci user assign permset -o orgAlias", "sf ci user assign permset --target-org orgAlias --permset-name Permset_DevName" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" }, "permset-name": { "char": "n", "description": "permission set name to assign", "name": "permset-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ci-config-file": { "char": "x", "description": "path to a 'ciconfig.json' file with 'permsets' array property", "name": "ci-config-file", "default": "ciconfig.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:user:assign:permset", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "user", "assign", "permset.js" ], "aliasPermutations": [], "permutations": [ "ci:user:assign:permset", "user:ci:assign:permset", "user:assign:ci:permset", "user:assign:permset:ci", "ci:assign:user:permset", "assign:ci:user:permset", "assign:user:ci:permset", "assign:user:permset:ci", "ci:assign:permset:user", "assign:ci:permset:user", "assign:permset:ci:user", "assign:permset:user:ci", "ci:user:permset:assign", "user:ci:permset:assign", "user:permset:ci:assign", "user:permset:assign:ci", "ci:permset:user:assign", "permset:ci:user:assign", "permset:user:ci:assign", "permset:user:assign:ci", "ci:permset:assign:user", "permset:ci:assign:user", "permset:assign:ci:user", "permset:assign:user:ci" ] }, "ci:user:assign:permsetgroup": { "aliases": [], "args": {}, "description": "Assigns permission set groups to an authenticated user.", "examples": [ "sf ci user assign permsetgroup -o orgAlias", "sf ci user assign permsetgroup --target-org orgAlias --permset-group-name PermsetGroup_DevName" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" }, "permset-group-name": { "char": "n", "description": "permission set group name to assign", "name": "permset-group-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ci-config-file": { "char": "x", "description": "path to a 'ciconfig.json' file with 'permsetGroups' array property", "name": "ci-config-file", "default": "ciconfig.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:user:assign:permsetgroup", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "user", "assign", "permsetgroup.js" ], "aliasPermutations": [], "permutations": [ "ci:user:assign:permsetgroup", "user:ci:assign:permsetgroup", "user:assign:ci:permsetgroup", "user:assign:permsetgroup:ci", "ci:assign:user:permsetgroup", "assign:ci:user:permsetgroup", "assign:user:ci:permsetgroup", "assign:user:permsetgroup:ci", "ci:assign:permsetgroup:user", "assign:ci:permsetgroup:user", "assign:permsetgroup:ci:user", "assign:permsetgroup:user:ci", "ci:user:permsetgroup:assign", "user:ci:permsetgroup:assign", "user:permsetgroup:ci:assign", "user:permsetgroup:assign:ci", "ci:permsetgroup:user:assign", "permsetgroup:ci:user:assign", "permsetgroup:user:ci:assign", "permsetgroup:user:assign:ci", "ci:permsetgroup:assign:user", "permsetgroup:ci:assign:user", "permsetgroup:assign:ci:user", "permsetgroup:assign:user:ci" ] }, "ci:user:assign:profile": { "aliases": [], "args": {}, "description": "Assigns profile to the currently authenticated user.", "examples": [ "sf ci user assign profile -o orgAlias", "sf ci user assign profile --target-org orgAlias --profile-name \"Custom Admin Profile\"" ], "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": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "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" }, "profile-name": { "char": "n", "description": "profile name to assign", "name": "profile-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ci-config-file": { "char": "x", "description": "path to a 'ciconfig.json' file with 'profile' property", "name": "ci-config-file", "default": "ciconfig.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "ci:user:assign:profile", "pluginAlias": "ci-sf-plugin", "pluginName": "ci-sf-plugin", "pluginType": "core", "strict": true, "enableJsonFlag": true, "requiresProject": false, "isESM": true, "relativePath": [ "lib", "commands", "ci", "user", "assign", "profile.js" ], "aliasPermutations": [], "permutations": [ "ci:user:assign:profile", "user:ci:assign:profile", "user:assign:ci:profile", "user:assign:profile:ci", "ci:assign:user:profile", "assign:ci:user:profile", "assign:user:ci:profile", "assign:user:profile:ci", "ci:assign:profile:user", "assign:ci:profile:user", "assign:profile:ci:user", "assign:profile:user:ci", "ci:user:profile:assign", "user:ci:profile:assign", "user:profile:ci:assign", "user:profile:assign:ci", "ci:profile:user:assign", "profile:ci:user:assign", "profile:user:ci:assign", "profile:user:assign:ci", "ci:profile:assign:user", "profile:ci:assign:user", "profile:assign:ci:user", "profile:assign:user:ci" ] } }, "version": "0.0.19" }