sf-org-mapper

Using the template

This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:

Please get in touch with the Platform CLI team. We want to help you develop your plugin.

Generate your plugin:

sf plugins install dev
sf dev generate plugin

git init -b main
git add . && git commit -m "chore: initial commit"

Create your plugin's repo in the salesforcecli github org
When you're ready, replace the contents of this README with the information you want.

Learn about `sf` plugins

Salesforce CLI plugins are based on the oclif plugin framework. Read the plugin developer guide to learn about Salesforce CLI plugin development.

This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the node developer packages used by Salesforce.

Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the posttest script and it is required to keep these tests active in your plugin if you plan to have it bundled.

Tooling

Hooks

For cross clouds commands, e.g. sf env list, we utilize oclif hooks to get the relevant information from installed plugins.

This plugin includes sample hooks in the src/hooks directory. You'll just need to add the appropriate logic. You can also delete any of the hooks if they aren't required for your plugin.

Everything past here is only a suggestion as to what should be in your specific plugin's description

This plugin is bundled with the Salesforce CLI. For more information on the CLI, read the getting started guide.

We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.

Install

sf plugins install sf-org-mapper@x.y.z

Issues

Please report any issues at https://github.com/forcedotcom/cli/issues

Contributing

Please read our Code of Conduct
Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
Fork this repository.
Build the plugin locally
Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
Edit the code in your fork.
Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
Sign CLA (see CLA below).
Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

CLA

External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.

Build

To build the plugin locally, make sure to have yarn installed and run the following commands:

# Clone the repository
git clone git@github.com:salesforcecli/sf-org-mapper

# Install the dependencies and compile
yarn && yarn build

To use your plugin, run using the local ./bin/dev or ./bin/dev.cmd file.

# Run using local run file.
./bin/dev hello world

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins

`sf map dependencies`

Build a graph with the dependencies of a metadata element.

USAGE
  $ sf map dependencies -o <value> --metadata <value>... [--json] [--flags-dir <value>] [-a <value>] [-f <value>...]
    [-d <value>] [-t <value>...] [--exclude-types <value>...] [-n <value>...] [--exclude-namespaces <value>...] [-m
    <value>...] [--exclude-manageable-states <value>...] [-p] [--merge] [--transitive]

FLAGS
  -a, --api-version=<value>                   Target API version for the deploy.
  -d, --output-dir=<value>                    Directory in which to generate the gefx file; default is current
                                              directory.
  -f, --files=<value>...                      MedataComponentDependency csv files.
  -m, --include-manageable-states=<value>...  Manageable states to include in the graph
  -n, --include-namespaces=<value>...         Namespaces to include in the graph
  -o, --target-org=<value>                    (required) Username or alias of the target org. Not required if the
                                              `target-org` configuration variable is already set.
  -p, --include-package-info                  ADd package info to the nodes.
  -t, --include-types=<value>...              Types to include in the graph
      --exclude-manageable-states=<value>...  Manageable states to exclude from the graph
      --exclude-namespaces=<value>...         Namespaces to exclude from the graph
      --exclude-types=<value>...              Types to exclude from the graph
      --merge                                 Merge resulting graphs into one
      --metadata=<value>...                   (required) List of metadata
      --transitive                            Creates graph with less edges

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Build a graph with the dependencies of a metadata element.

  More information about a command. Don't repeat the summary.

FLAG DESCRIPTIONS
  -a, --api-version=<value>  Target API version for the deploy.

    Use this flag to override the default API version with the API version of your package.xml file. The default API
    version is the latest version supported by the CLI.

`sf map metadata`

Summary of a command.

USAGE
  $ sf map metadata -o <value> [--json] [--flags-dir <value>] [-a <value>] [-f <value>...] [-d <value>] [-t
    <value>...] [--exclude-types <value>...] [-n <value>...] [--exclude-namespaces <value>...] [-m <value>...]
    [--exclude-manageable-states <value>...] [-p]

FLAGS
  -a, --api-version=<value>                   Target API version for the deploy.
  -d, --output-dir=<value>                    Directory in which to generate the gefx file; default is current
                                              directory.
  -f, --files=<value>...                      MedataComponentDependency csv files.
  -m, --include-manageable-states=<value>...  Manageable states to include in the graph
  -n, --include-namespaces=<value>...         Namespaces to include in the graph
  -o, --target-org=<value>                    (required) Username or alias of the target org. Not required if the
                                              `target-org` configuration variable is already set.
  -p, --include-package-info                  ADd package info to the nodes.
  -t, --include-types=<value>...              Types to include in the graph
      --exclude-manageable-states=<value>...  Manageable states to exclude from the graph
      --exclude-namespaces=<value>...         Namespaces to exclude from the graph
      --exclude-types=<value>...              Types to exclude from the graph

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Summary of a command.

  More information about a command. Don't repeat the summary.

EXAMPLES
  $ sf map metadata

FLAG DESCRIPTIONS
  -a, --api-version=<value>  Target API version for the deploy.

    Use this flag to override the default API version with the API version of your package.xml file. The default API
    version is the latest version supported by the CLI.

`sf map org`

Say hello.

USAGE
  $ sf map org -o <value> [--json] [--flags-dir <value>] [-a <value>] [-f <value>...] [-d <value>] [-p]

FLAGS
  -a, --api-version=<value>   Target API version for the deploy.
  -d, --output-dir=<value>    Directory in which to generate the gefx file; default is current directory.
  -f, --files=<value>...      MedataComponentDependency csv files.
  -o, --target-org=<value>    (required) Username or alias of the target org. Not required if the `target-org`
                              configuration variable is already set.
  -p, --include-package-info  ADd package info to the nodes.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Say hello.

  Say hello either to the world or someone you know.

FLAG DESCRIPTIONS
  -a, --api-version=<value>  Target API version for the deploy.

    Use this flag to override the default API version with the API version of your package.xml file. The default API
    version is the latest version supported by the CLI.

`sf map uses`

Summary of a command.

USAGE
  $ sf map uses -o <value> --metadata <value>... [--json] [--flags-dir <value>] [-a <value>] [-f <value>...]
    [-d <value>] [-t <value>...] [--exclude-types <value>...] [-n <value>...] [--exclude-namespaces <value>...] [-m
    <value>...] [--exclude-manageable-states <value>...] [-p] [--merge] [--transitive]

FLAGS
  -a, --api-version=<value>                   Target API version for the deploy.
  -d, --output-dir=<value>                    Directory in which to generate the gefx file; default is current
                                              directory.
  -f, --files=<value>...                      MedataComponentDependency csv files.
  -m, --include-manageable-states=<value>...  Manageable states to include in the graph
  -n, --include-namespaces=<value>...         Namespaces to include in the graph
  -o, --target-org=<value>                    (required) Username or alias of the target org. Not required if the
                                              `target-org` configuration variable is already set.
  -p, --include-package-info                  ADd package info to the nodes.
  -t, --include-types=<value>...              Types to include in the graph
      --exclude-manageable-states=<value>...  Manageable states to exclude from the graph
      --exclude-namespaces=<value>...         Namespaces to exclude from the graph
      --exclude-types=<value>...              Types to exclude from the graph
      --merge                                 Merge resulting graphs into one
      --metadata=<value>...                   (required) List of metadata
      --transitive                            Creates graph with less edges

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Summary of a command.

  More information about a command. Don't repeat the summary.

EXAMPLES
  $ sf map uses

FLAG DESCRIPTIONS
  -a, --api-version=<value>  Target API version for the deploy.

    Use this flag to override the default API version with the API version of your package.xml file. The default API
    version is the latest version supported by the CLI.

sf-org-mapper

sf-org-mapper

Using the template

Learn about `sf` plugins

Tooling

Hooks

Everything past here is only a suggestion as to what should be in your specific plugin's description

Install

Issues

Contributing

CLA

Build

Commands

`sf map dependencies`

`sf map metadata`

`sf map org`

`sf map uses`

Readme

Keywords

Package Sidebar

Install

Weekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

sf-org-mapper

sf-org-mapper

Using the template

Learn about sf plugins

Tooling

Hooks

Everything past here is only a suggestion as to what should be in your specific plugin's description

Install

Issues

Contributing

CLA

Build

Commands

sf map dependencies

sf map metadata

sf map org

sf map uses

Readme

Keywords

Package Sidebar

Install

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

Learn about `sf` plugins

`sf map dependencies`

`sf map metadata`

`sf map org`

`sf map uses`

Weekly Downloads