qforce
Version:
Commands to help with salesforce development.
1 lines • 12.5 kB
JSON
{"version":"0.8.14","commands":{"dev:code":{"id":"dev:code","description":"Open all files committed in a branch in VS Code","pluginName":"qforce","pluginType":"core","aliases":["code","dev:code"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"name":{"name":"name","type":"option","char":"n","description":"name to print"},"force":{"name":"force","type":"boolean","char":"f","allowNo":false}},"args":[{"name":"featureBranch"},{"name":"developBranch"}]},"dev:config":{"id":"dev:config","description":"describe the command here","pluginName":"qforce","pluginType":"core","aliases":["config","dev:config"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"init":{"name":"init","type":"boolean","description":"Initiate qforce settings.","allowNo":false},"global":{"name":"global","type":"boolean","char":"g","description":"To set or retrieve setting from global.","allowNo":false},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"Set or retrieve targetusername."},"queryFilePath":{"name":"queryFilePath","type":"option","description":"Path of query file to use with query command."},"queryResultsPath":{"name":"queryResultsPath","type":"option","description":"Path to save results of query command."},"exeFilePath":{"name":"exeFilePath","type":"option","description":"Path to file to execute for exe command."},"exeResultsPath":{"name":"exeResultsPath","type":"option","description":"Path to save log of exe command execution."},"bulkStatusRetries":{"name":"bulkStatusRetries","type":"option","description":"Number of retries to poll status of bulk job."},"bulkStatusInterval":{"name":"bulkStatusInterval","type":"option","description":"Interval in milliseconds for polling bluk job status."},"lastDeployCommit":{"name":"lastDeployCommit","type":"option","description":"Commit hash of the last commit that was deployed."},"developBranch":{"name":"developBranch","type":"option","description":"Name of default develop branch."},"patchPath":{"name":"patchPath","type":"option","description":"Path to save the patch file when running patch command"},"featureYamlPath":{"name":"featureYamlPath","type":"option","description":"Path to save the feature YAML file"},"featureMetaPath":{"name":"featureMetaPath","type":"option","description":"Path to save the retrieved metadata files based on YAML"},"packageBasePath":{"name":"packageBasePath","type":"option","description":"Base path for sfdc package"}},"args":[{"name":"file"}]},"dev:deploy":{"id":"dev:deploy","description":"Deploy source components included in a feature branch.","pluginName":"qforce","pluginType":"core","aliases":["deploy","dev:deploy"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"username":{"name":"username","type":"option","char":"u"},"file":{"name":"file","type":"option","char":"f","description":"Relative path of YAML file in unix format."},"diff":{"name":"diff","type":"boolean","char":"d","description":"Set to true if passing commit hash.","allowNo":false},"isCommit":{"name":"isCommit","type":"boolean","char":"c","description":"Set to true if deploying a single commit.","allowNo":false},"lastDeployCommit":{"name":"lastDeployCommit","type":"option","description":"Commit hash of the last commit."}},"args":[{"name":"featureBranch"},{"name":"developBranch"}]},"dev:feature":{"id":"dev:feature","description":"To retrieve and deploy source based on YAML file.","pluginName":"qforce","pluginType":"core","aliases":["feature","dev:feature"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"start":{"name":"start","type":"boolean","char":"s","description":"Start a new feature. Will create YAML file and folder if not already exist.","allowNo":false},"buildFromDiff":{"name":"buildFromDiff","type":"boolean","description":"Build metadata components by running a diff.","allowNo":false},"buildFromDir":{"name":"buildFromDir","type":"boolean","description":"Build metadata components based on directory contents.","allowNo":false},"toXml":{"name":"toXml","type":"boolean","description":"Convert yml file to xml.","allowNo":false},"toYaml":{"name":"toYaml","type":"boolean","description":"Convert xml file to yml.","allowNo":false},"path":{"name":"path","type":"option","char":"p","description":"Path to app directory."},"retrieve":{"name":"retrieve","type":"boolean","char":"r","description":"Retrieve source based on YAML configuration.","allowNo":false},"deploy":{"name":"deploy","type":"boolean","char":"d","description":"Deploys source already retrieved.","allowNo":false},"username":{"name":"username","type":"option","char":"u"}},"args":[{"name":"featureName","required":true},{"name":"commit1","required":false},{"name":"commit2","required":false}]},"dev:migrate":{"id":"dev:migrate","description":"Migrate data from one org to another based on a migration plan.","pluginName":"qforce","pluginType":"core","aliases":["migrate","m"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"destination":{"name":"destination","type":"option","char":"d","description":"destination org username or alias"},"file":{"name":"file","type":"option","char":"f","description":"Path of migration plan file. Must be relative to cwd and in unix format."},"sample":{"name":"sample","type":"boolean","description":"Copy sample migration plan files to current directory.","allowNo":false},"source":{"name":"source","type":"option","char":"s","description":"source org username or alias."},"name":{"name":"name","type":"option","char":"n","description":"Name of the step to execute."},"clearDataFolder":{"name":"clearDataFolder","type":"boolean","allowNo":false},"clearRefFolder":{"name":"clearRefFolder","type":"boolean","allowNo":false}},"args":[]},"dev:patch":{"id":"dev:patch","description":"Prepare and apply a patch to current branch from another branch.","pluginName":"qforce","pluginType":"core","aliases":["patch","dev:patch"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"apply":{"name":"apply","type":"boolean","char":"a","description":"Set to true if want to apply calculated patch to current branch.","allowNo":false},"patchPath":{"name":"patchPath","type":"option","char":"p","description":"Path to save the patch file."},"syncUp":{"name":"syncUp","type":"boolean","char":"s","description":"Set to true if need to retrieve","allowNo":false},"partialCommit":{"name":"partialCommit","type":"option","char":"c","description":"Commit hash for calculating partial patch."}},"args":[{"name":"featureBranch"},{"name":"developBranch"}]},"dev:release":{"id":"dev:release","description":"To manage yml based release build, retrieve and deploy.","pluginName":"qforce","pluginType":"core","aliases":["release","dev:release"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"start":{"name":"start","type":"boolean","char":"s","description":"Start a new release. Will create YAML file and folder if not already exist.","allowNo":false},"build":{"name":"build","type":"boolean","char":"b","description":"To recalculate components based on features listed.","allowNo":false},"retrieve":{"name":"retrieve","type":"boolean","char":"r","description":"Retrieve source based on YAML configuration.","allowNo":false},"deploy":{"name":"deploy","type":"boolean","char":"d","description":"Deploys source already retrieved.","allowNo":false},"username":{"name":"username","type":"option","char":"u"},"addFeature":{"name":"addFeature","type":"option","char":"a","description":"Adds one or more features to the release specified."},"removeFeature":{"name":"removeFeature","type":"option","char":"R","description":"Removes one or more features from the release specified."}},"args":[{"name":"releaseName"}]},"dev:retrieve":{"id":"dev:retrieve","description":"To retrieve metadat based on items listed in a YAML file.","pluginName":"qforce","pluginType":"core","aliases":["retrieve","dev:retrieve"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"username":{"name":"username","type":"option","char":"u"},"file":{"name":"file","type":"option","char":"f","description":"Relative path of YAML file in unix format."}},"args":[{"name":"file"}]},"dev:snippet":{"id":"dev:snippet","description":"Generates VS Code snippets to help using qforce.","pluginName":"qforce","pluginType":"core","aliases":["snippet","dev:snippet"],"examples":["$ qforce snippet --init //Creates a snippets file for saving qforce related snippets.","$ qforce snippet -q -a q_1 //Saves contents of queryFilePath into a snippet named q_1.","$ qforce snippet -q -e e_1 //Saves contents of exeFilePath into a snippet named e_1."],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"init":{"name":"init","type":"boolean","char":"i","description":"To initialize snippet file.","allowNo":false},"query":{"name":"query","type":"boolean","char":"q","description":"Create alias for query at default query path.","allowNo":false},"exe":{"name":"exe","type":"boolean","char":"e","description":"Create alias for anonymous apex at default exe path.","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"Alias for the snippet"},"path":{"name":"path","type":"option","char":"p","description":"Path to file that needs to be converted to snippet. Required if query/exe flags not passed"}},"args":[]},"dev:update":{"id":"dev:update","description":"Update package","pluginName":"qforce","pluginType":"core","aliases":["update","dev:update"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"file"}]},"dx:describe":{"id":"dx:describe","description":"describe the command here","pluginName":"qforce","pluginType":"core","aliases":["describe","dx:describe"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"username":{"name":"username","type":"option","char":"u"},"sobject":{"name":"sobject","type":"option","char":"s","description":"sObject name."},"result":{"name":"result","type":"option","char":"r","description":"Relative path to save results."},"all":{"name":"all","type":"boolean","char":"a","description":"To get all sObjects.","allowNo":false}},"args":[]},"dx:exe":{"id":"dx:exe","description":"Execute anonymous apex.","pluginName":"qforce","pluginType":"core","aliases":["exe","dx:exe"],"examples":["$ q dx:exe"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"username":{"name":"username","type":"option","char":"u"},"file":{"name":"file","type":"option","char":"f","description":"Relative path of apex file in unix format."},"result":{"name":"result","type":"option","char":"r","description":"Relative path to save results."}},"args":[]},"dx:ol":{"id":"dx:ol","description":"List of available orgs.","pluginName":"qforce","pluginType":"core","aliases":[],"examples":["$ q dx:ol"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"verbose":{"name":"verbose","type":"boolean","char":"v","allowNo":false}},"args":[]},"dx:open":{"id":"dx:open","description":"Open an org.","pluginName":"qforce","pluginType":"core","aliases":["open","dx:open","o"],"examples":["$ q dx:open uat"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"username","required":true},{"name":"path","required":false}]},"dx:query":{"id":"dx:query","description":"Run a SOQL and save results to csv.","pluginName":"qforce","pluginType":"core","aliases":["query","q","dx:query"],"examples":["$ qforce dx:query"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"username":{"name":"username","type":"option","char":"u"},"file":{"name":"file","type":"option","char":"f","description":"Relative path of query file in unix format."},"query":{"name":"query","type":"option","char":"q","description":"SOQL query as string."},"result":{"name":"result","type":"option","char":"r","description":"Relative path to save results of query."}},"args":[]}}}