The SharinPix Salesforce CLI plugin provides tools to interact with SharinPix organization configuration, form templates, and permissions in your Salesforce orgs. This plugin allows you to pull and push configs, form templates, and permissions from/to your Salesforce org, saving them as local JSON files for version control and deployment management.
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.
- @salesforce/core
- @salesforce/kit
- @salesforce/sf-plugins-core
- @salesforce/ts-types
- @salesforce/ts-sinon
- @salesforce/dev-config
- @salesforce/dev-scripts
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.
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.
sf org login web
sf plugins install @sharinpix/sharinpix-sf-cli
# Pull all (configs, forms, and permissions) from Salesforce
sf sharinpix pull -o yourusername@salesforce.com
# Push all (configs, forms, and permissions) to Salesforce
sf sharinpix push -o yourusername@salesforce.com
# Pull individual components
sf sharinpix config pull -o yourusername@salesforce.com
sf sharinpix form pull -o yourusername@salesforce.com
sf sharinpix permission pull -o yourusername@salesforce.com
# Push individual components
sf sharinpix config push -o yourusername@salesforce.com
sf sharinpix form push -o yourusername@salesforce.com
sf sharinpix permission push -o yourusername@salesforce.com
# Push with deletion of orphaned records (for forms and permissions only)
sf sharinpix push -o yourusername@salesforce.com --delete
sf sharinpix form push -o yourusername@salesforce.com --delete
sf sharinpix permission push -o yourusername@salesforce.com -dPlease report any issues at https://github.com/sharinpix/sharinpix-sf-cli/issues
- 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.
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.
To build the plugin locally, make sure to have npm installed and run the following commands:
# Clone the repository
git clone git@github.com:sharinpix/sharinpix-sf-cli
# Install the dependencies and compile
yarn && yarn run buildTo use your plugin, run using the local ./bin/dev or ./bin/dev.cmd file.
# Run using local run file.
./bin/dev sharinpix pull --target-org myorg@example.com
./bin/dev sharinpix config pull --target-org myorg@example.com
./bin/dev sharinpix form pull --target-org myorg@example.com
./bin/dev sharinpix permission pull --target-org myorg@example.comThere 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 pluginsBoth form push and permission push commands support a --delete/-d flag that provides automatic cleanup of orphaned records:
- Orphaned Records: Records that exist in your Salesforce org but no longer have corresponding local JSON files
- Safety: Deletion only occurs when the flag is explicitly provided
- Reporting: The command reports how many records were deleted, failed, uploaded, and skipped
- Error Handling: If a deletion fails, it's logged as a warning and counted in the failed total
--delete flag with caution as deletions cannot be undone. Always ensure you have backups of your data before using this feature.
Example Workflow:
- Pull existing records:
sf sharinpix form pull - Remove unwanted local JSON files
- Push with cleanup:
sf sharinpix form push --delete
sf sharinpix pullsf sharinpix pushsf sharinpix settingssf sharinpix config pullsf sharinpix config pushsf sharinpix form csv2jsonsf sharinpix form json2csvsf sharinpix form pullsf sharinpix form pushsf sharinpix permission pullsf sharinpix permission push
Pull all SharinPix components (configs, forms, and permissions) from Salesforce org.
USAGE
$ sf sharinpix pull [--json] [-o <value>]
FLAGS
-o, --target-org=<value> The Salesforce org to pull components from.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Retrieves all SharinPix components including organization configuration, form templates, and permissions from the connected Salesforce org. This is a convenience command that executes sharinpix:config:pull, sharinpix:form:pull, and sharinpix:permission:pull.
EXAMPLES
Pull all components from the default org:
$ sf sharinpix pull
Pull all components from a specific org:
$ sf sharinpix pull --target-org myorg@example.com
Push all SharinPix components (configs, forms, and permissions) to Salesforce org.
USAGE
$ sf sharinpix push [--json] [-o <value>] [-d]
FLAGS
-d, --delete Delete forms and permissions in the org that do not exist locally.
-o, --target-org=<value> The Salesforce org to push components to.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Uploads all local SharinPix components including organization configuration, form templates, and permissions to the connected Salesforce org. This is a convenience command that executes sharinpix:config:push, sharinpix:form:push, and sharinpix:permission:push.
When the --delete flag is used, the command will also delete form template and permission records from Salesforce that no longer have corresponding local JSON files. Use this flag with caution as deletions cannot be undone. Note: The delete flag does not apply to configs.
EXAMPLES
Push all components to the default org:
$ sf sharinpix push
Push all components to a specific org:
$ sf sharinpix push --target-org myorg@example.com
Push all components and delete missing forms/permissions from the org:
$ sf sharinpix push --delete
Open the SharinPix settings page in a Salesforce org.
USAGE
$ sf sharinpix settings [--json] [-o <value>]
FLAGS
-o, --target-org=<value> The Salesforce org to open.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Opens the SharinPix settings Lightning page in your default browser for the specified Salesforce org. This command is a convenience wrapper around `sf org open` with the path set to `/lightning/n/sharinpix__SharinPix_setting`.
EXAMPLES
Open the SharinPix settings page for a specific org:
$ sf sharinpix settings --target-org myorg@example.com
Pull SharinPix organization configuration from Salesforce org.
USAGE
$ sf sharinpix config pull [--json] [-o <value>]
FLAGS
-o, --target-org=<value> The Salesforce org to pull configuration from.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Retrieves the SharinPix organization configuration from the connected Salesforce org and saves it as a JSON file in the local sharinpix/config.json file.
EXAMPLES
Pull configuration from the default org:
$ sf sharinpix config pull
Pull configuration from a specific org:
$ sf sharinpix config pull --target-org myorg@example.com
Push SharinPix organization configuration to Salesforce org.
USAGE
$ sf sharinpix config push [--json] [-o <value>]
FLAGS
-o, --target-org=<value> The Salesforce org to push configuration to.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Uploads the SharinPix organization configuration from the local sharinpix/config.json file to the connected Salesforce org.
EXAMPLES
Push configuration to the default org:
$ sf sharinpix config push
Push configuration to a specific org:
$ sf sharinpix config push --target-org myorg@example.com
Generate JSON files from SharinPix form CSV definitions.
USAGE
$ sf sharinpix form csv2json [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Scans the local sharinpix/forms directory for SharinPix form CSV definition files and generates corresponding JSON files. Each CSV file is expected to have a header row of element keys and one row per element, as produced by the json2csv command.
EXAMPLES
Generate JSON files for all local SharinPix form CSV definitions:
$ sf sharinpix form csv2json
Generate CSV files from SharinPix form JSON definitions.
USAGE
$ sf sharinpix form json2csv [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Scans the local sharinpix/forms directory for SharinPix form JSON definition files and generates corresponding CSV files. The CSV files contain a header row built from all element keys and one row per element. Nested values are stringified.
EXAMPLES
Generate CSV files for all local SharinPix form JSON definitions:
$ sf sharinpix form json2csv
Pull SharinPix form templates from Salesforce org.
USAGE
$ sf sharinpix form pull [--json] [-o <value>]
FLAGS
-o, --target-org=<value> The Salesforce org to pull form templates from.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Retrieves all SharinPix form templates from the connected Salesforce org and saves them as JSON files in the local sharinpix/forms directory. This command fetches the form template metadata and downloads the actual form definition files.
EXAMPLES
Pull all form templates from the default org:
$ sf sharinpix form pull
Pull form templates from a specific org:
$ sf sharinpix form pull --target-org myorg@example.com
Push SharinPix form templates to Salesforce org.
USAGE
$ sf sharinpix form push [--json] [-o <value>] [-d]
FLAGS
-d, --delete Delete form templates from org that no longer have corresponding local files.
-o, --target-org=<value> The Salesforce org to push form templates to.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Uploads SharinPix form templates from local JSON files to the connected Salesforce org. This command reads form templates from the local directory and creates or updates corresponding records in Salesforce. Existing forms will be updated unless the force flag is used to skip them.
When the --delete flag is used, the command will also delete form template records from Salesforce that no longer have corresponding local JSON files. Use this flag with caution as deletions cannot be undone.
EXAMPLES
Push all form templates to the default org:
$ sf sharinpix form push
Push form templates to a specific org:
$ sf sharinpix form push --target-org myorg@example.com
Push form templates and delete orphaned records:
$ sf sharinpix form push --delete
Push to specific org with deletion:
$ sf sharinpix form push --target-org myorg@example.com --delete
Pull SharinPix permissions from Salesforce org.
USAGE
$ sf sharinpix permission pull [--json] [-o <value>]
FLAGS
-o, --target-org=<value> The Salesforce org to pull SharinPix permissions from.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Retrieves all SharinPix permissions from the connected Salesforce org and saves them as JSON files in the local sharinpix/permissions directory. This command fetches the permission metadata and the JSON configuration data stored in the sharinpix__Json__c field.
EXAMPLES
Pull all SharinPix permissions from the default org:
$ sf sharinpix permission pull
Pull SharinPix permissions from a specific org:
$ sf sharinpix permission pull --target-org myorg@example.com
Push SharinPix permissions to Salesforce org.
USAGE
$ sf sharinpix permission push [--json] [-o <value>] [-d]
FLAGS
-d, --delete Delete SharinPix permissions from org that no longer have corresponding local files.
-o, --target-org=<value> The Salesforce org to push SharinPix permissions to.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Uploads SharinPix permissions from local JSON files to the connected Salesforce org. This command reads permission configurations from the local directory and creates or updates corresponding records in Salesforce. The sharinpix__Json__c field will be updated with the JSON configuration data.
When the --delete flag is used, the command will also delete SharinPix permission records from Salesforce that no longer have corresponding local JSON files. Use this flag with caution as deletions cannot be undone.
EXAMPLES
Push all SharinPix permissions to the default org:
$ sf sharinpix permission push
Push SharinPix permissions to a specific org:
$ sf sharinpix permission push --target-org myorg@example.com
Push SharinPix permissions and delete orphaned records:
$ sf sharinpix permission push --delete
Push to specific org with deletion:
$ sf sharinpix permission push --target-org myorg@example.com -d