SharinPix Salesforce CLI Plugin

GitHub - SharinPix/sharinpix-sf-plugin: SharinPix salesforce pluginGitHub

The SharinPix Salesforce CLI plugin syncs SharinPix forms, permissions, and settings between Salesforce and files on your computer.

Use it to version, review, and deploy SharinPix configuration and files across environments.

In this article, we will demonstrate how to:

• Set up Node.js and install the plugin
• Authenticate to Salesforce
• Discover available commands
• Pull SharinPix configuration locally
• Push local changes back to Salesforce

Prerequisites

Before you begin, ensure that:

• Node.js is installed
• Salesforce CLI (sf) is installed
• You have access to a Salesforce org
• Your Salesforce user has access to SharinPix features

Install the SharinPix Salesforce CLI Plugin

Run the following command to install the plugin:

sf plugins install @sharinpix/sharinpix-sf-cli

Authenticate to Salesforce

Use the web login flow to connect your org.

Connect to a production org

sf org login web

Connect to a sandbox or test org

Use --instance-url with the Salesforce test login domain:

sf org login web --instance-url https://test.salesforce.com

List authenticated orgs:

sf org list

Commands

Discover available commands

Use --help to inspect the plugin and each command:

sf sharinpix --help
sf sharinpix form pull --help
sf sharinpix pull --help
sf sharinpix form push --help
sf sharinpix push --help

Target org

All plugin commands require a target Salesforce org.

Pass the login username with -o:

-o [email protected]

Pull SharinPix forms

sf sharinpix form pull -o [email protected]

Use this command when you only need SharinPix forms.

Pull all SharinPix configuration

sf sharinpix pull -o [email protected]

This pulls all supported SharinPix configuration from the target org.

Push SharinPix forms

sf sharinpix form push -o [email protected]

Use this command when you only need to deploy SharinPix forms.

Push all local configuration

sf sharinpix push -o [email protected]

This applies all supported local SharinPix configuration to the target org.

Info

Pull updates files on your computer, and Push applies those files to Salesforce.

After each command, check:

• The target org is correct
• The expected files changed
• No errors were reported

Warning

Some flags, such as --delete, can remove Salesforce records that do not exist locally.

Use this only when the files on your computer are the source of truth.

Additional information

For the full command reference, see the complete documentation on GitHub:

sharinpix-sf-plugin/README.md at main · SharinPix/sharinpix-sf-pluginGitHub