{"id":45773478,"url":"https://github.com/salesforcecli/plugin-command-reference","last_synced_at":"2026-05-09T05:14:13.087Z","repository":{"id":171104686,"uuid":"243359925","full_name":"salesforcecli/plugin-command-reference","owner":"salesforcecli","description":"Generate the Salesforce CLI command reference guide.","archived":false,"fork":false,"pushed_at":"2026-05-03T09:09:17.000Z","size":6545,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-05-03T11:20:22.455Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/salesforcecli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-02-26T20:33:45.000Z","updated_at":"2026-05-03T09:08:11.000Z","dependencies_parsed_at":"2026-04-02T01:07:15.884Z","dependency_job_id":null,"html_url":"https://github.com/salesforcecli/plugin-command-reference","commit_stats":null,"previous_names":["salesforcecli/plugin-command-reference"],"tags_count":305,"template":false,"template_full_name":null,"purl":"pkg:github/salesforcecli/plugin-command-reference","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-command-reference","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-command-reference/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-command-reference/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-command-reference/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/salesforcecli","download_url":"https://codeload.github.com/salesforcecli/plugin-command-reference/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/salesforcecli%2Fplugin-command-reference/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32807950,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-26T07:54:54.136Z","updated_at":"2026-05-09T05:14:13.074Z","avatar_url":"https://github.com/salesforcecli.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @salesforce/plugin-command-reference\n\nGenerate the [Salesforce CLI command reference guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/).\n\n[![Version](https://img.shields.io/npm/v/@salesforce/plugin-command-reference.svg)](https://npmjs.org/package/@salesforce/plugin-command-reference)\n[![Codecov](https://codecov.io/gh/salesforcecli/plugin-command-reference/branch/master/graph/badge.svg)](https://codecov.io/gh/salesforcecli/plugin-command-reference)\n[![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-command-reference.svg)](https://npmjs.org/package/@salesforce/plugin-command-reference)\n[![License](https://img.shields.io/npm/l/@salesforce/plugin-command-reference.svg)](https://github.com/salesforcecli/plugin-command-reference/blob/master/package.json)\n\nFirst install the plugin.\n\n```bash\n$ sf plugins install @salesforce/plugin-command-reference\n```\n\nEnsure any plugins are installed that you with to generate documentation for.\n\n```bash\n$ sf plugins:install salesforce@plugin-auth\n```\n\nNow we can generate the documentation for all core plug-ins.\n\n```bash\n# notice we can use the oclif shorthand for the plugin name.  @salesforce/plugin-foo =\u003e foo\n$ sf commandreference --plugins auth\n```\n\n**Note:** Warnings will occur for missing properties in plugins. Those have to be fixed in the plugin itself.\n\n## Add to your Salesforce CLI Plugin\n\nTo add this to your plugin to catch warning at development time, add it as a dev plugin in the project.json.\n\n```json\n\"oclif\": {\n  \"devPlugins\": [\n    \"@salesforce/plugin-command-reference\"\n  ]\n}\n```\n\nThen you can run this in your plugin's CI.\n\n```sh-session\n./bin/dev commandreference --plugins \u003cname-of-your-plugin\u003e --error-on-warnings\n```\n\n## Local Development\n\nIf you need to make changes to this repository, the easiest thing to do is to link it to your Salesforce CLI. After you cloned this plugin, run the following from this plugin directory:\n\n```sh-session\nsf plugins link .\n```\n\n## Testing\n\nHow do you know if the output is correct, given your change?\n\n```bash\n# Install the current version of the plugin (use `@sf` until the plugin is publishing the sf version as main)\nsf plugins install @salesforce/plugin-command-reference@sf\n# installs all JIT plugins (if you intend to produce ditamaps for them)\nsf jit install\n# run using a relatively current version of plugins, saving the output as a \"gold file\"\nsf commandreference generate --plugins login env deploy-retrieve settings functions info sobject limits schema custom-metadata data community signups user org packaging templates apex auth dev @salesforce/sfdx-plugin-lwc-test -d outputGold\n```\n\nWhile working on your branch\n\n```bash\nsf plugins link .\n# run the same command from above, but with your new version of the plugin, writing to a new output file\nsf commandreference generate --plugins login env deploy-retrieve settings functions info sobject limits schema custom-metadata data community signups user org packaging templates apex auth dev @salesforce/sfdx-plugin-lwc-test -d outputNew\n```\n\nNow diff the output. Changes should be intentional!\n\n## Commands\n\n\u003c!-- commands --\u003e\n\n- [`sf commandreference generate`](#sf-commandreference-generate)\n- [`sf jit install`](#sf-jit-install)\n\n## `sf commandreference generate`\n\ngenerate the command reference guide located\n\n```\nUSAGE\n  $ sf commandreference generate [--json] [--flags-dir \u003cvalue\u003e] [-d \u003cvalue\u003e] [-p \u003cvalue\u003e... | -a] [-s \u003cvalue\u003e] [--hidden]\n    [--error-on-warnings] [-c \u003cvalue\u003e]\n\nFLAGS\n  -a, --all                     include all relevant plugins in the generation\n  -c, --config-path=\u003cvalue\u003e     A path to the directory containing a plugin or cli\n  -d, --output-dir=\u003cvalue\u003e      [default: ./tmp/root] output directory to put generated files\n  -p, --plugins=\u003cvalue\u003e...      comma separated list of plugin names to be part of the generation. Defaults to the oclif\n                                plugin in the current working directory\n  -s, --ditamap-suffix=\u003cvalue\u003e  [default: unified] unique suffix to append to generated ditamap\n      --error-on-warnings       fail the command if there are any warnings\n      --hidden                  show hidden commands\n\nGLOBAL FLAGS\n  --flags-dir=\u003cvalue\u003e  Import flag values from a directory.\n  --json               Format output as json.\n\nDESCRIPTION\n  generate the command reference guide located\n\n  generate the command reference guide located\n\nEXAMPLES\n  Generate the command reference guide\n\n    $ sf commandreference generate\n\n  Generate the command reference for a set of plugins\n\n    $ sf commandreference generate --plugins pluginA,pluginB\n\n  Generate the command reference for all plugins\n\n    $ sf commandreference generate --all --output-dir ./docs\n\n  Generate the command reference for all plugins in a directory\n\n    $ sf commandreference generate --all --config-path /path/to/plugin --output-dir ./docs\n```\n\n_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.1.96/src/commands/commandreference/generate.ts)_\n\n## `sf jit install`\n\nInstall all JIT plugins.\n\n```\nUSAGE\n  $ sf jit install [--json] [--flags-dir \u003cvalue\u003e] [-d]\n\nFLAGS\n  -d, --dry-run  List the plugins that would be installed.\n\nGLOBAL FLAGS\n  --flags-dir=\u003cvalue\u003e  Import flag values from a directory.\n  --json               Format output as json.\n\nEXAMPLES\n  $ sf jit install\n```\n\n_See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.1.96/src/commands/jit/install.ts)_\n\n\u003c!-- commandsstop --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalesforcecli%2Fplugin-command-reference","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsalesforcecli%2Fplugin-command-reference","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalesforcecli%2Fplugin-command-reference/lists"}