npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@sharinpix/sharinpix-sf-cli

v1.9.0

Published

SharinPix salesforce cli plugin

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

ombrombrsharinpix-adminsharinpix-adminzafirskthelifehackerzafirskthelifehackerazharbeebeejaunazharbeebeejaun

Keywords

forcesalesforcesalesforcedxsfsf-pluginsfdxsfdx-plugin

Readme

SharinPix Salesforce CLI Plugin

NPM Downloads/week License

The SharinPix Salesforce CLI plugin provides tools to interact with SharinPix form templates and permissions in your Salesforce orgs. This plugin allows you to pull and push form templates and permissions from/to your Salesforce org, saving them as local JSON files for version control and deployment management.

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.

Usage

sf org login web
sf plugins install @sharinpix/sharinpix-sf-cli

# Pull form templates and permissions from Salesforce
sf sharinpix form pull -o [email protected]
sf sharinpix permission pull -o [email protected]

# Push form templates and permissions to Salesforce
sf sharinpix form push -o [email protected]
sf sharinpix permission push -o [email protected]

# Push with deletion of orphaned records (records that exist in Salesforce but have no corresponding local files)
sf sharinpix form push -o [email protected] --delete
sf sharinpix permission push -o [email protected] -d

Issues

Please report any issues at https://github.com/sharinpix/sharinpix-sf-cli/issues

Contributing

  1. Please read our Code of Conduct
  2. 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.
  3. Fork this repository.
  4. Build the plugin locally
  5. Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
  6. Edit the code in your fork.
  7. 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.
  8. Sign CLA (see CLA below).
  9. 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 npm installed and run the following commands:

# Clone the repository
git clone [email protected]:sharinpix/sharinpix-sf-cli

# Install the dependencies and compile
yarn && yarn run build

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

# Run using local run file.
./bin/dev sharinpix form pull --target-org [email protected]
./bin/dev sharinpix permission pull --target-org [email protected]

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

Key Features

Deletion Functionality

Both 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

⚠️ Important: Use the --delete flag with caution as deletions cannot be undone. Always ensure you have backups of your data before using this feature.

Example Workflow:

  1. Pull existing records: sf sharinpix form pull
  2. Remove unwanted local JSON files
  3. Push with cleanup: sf sharinpix form push --delete

Commands

sf sharinpix form pull

Pull SharinPix form templates from Salesforce org.

USAGE
  $ sf sharinpix form pull -o <value> [--json] [--flags-dir <value>]

FLAGS
  -o, --org=<value>  (required) The Salesforce org to pull form templates from.

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

DESCRIPTION
  Pull SharinPix form templates from Salesforce org.

  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 [email protected]

FLAG DESCRIPTIONS
  -o, --org=<value>  The Salesforce org to pull form templates from.

    The target Salesforce org containing the SharinPix form templates to be pulled.

sf sharinpix form push

Push SharinPix form templates to Salesforce org.

USAGE
  $ sf sharinpix form push -o <value> [--json] [--flags-dir <value>] [-d]

FLAGS
  -d, --delete       Delete form templates from org that no longer have corresponding local files.
  -o, --org=<value>  (required) The Salesforce org to push form templates to.

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

DESCRIPTION
  Push SharinPix form templates to Salesforce org.

  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.

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 [email protected]

  Push form templates and delete orphaned records:

    $ sf sharinpix form push --delete

FLAG DESCRIPTIONS
  -d, --delete  Delete form templates from org that no longer have corresponding local files.

    When enabled, this flag will delete form template records from the Salesforce org if their corresponding local JSON
    files are missing. Use with caution as this operation cannot be undone.

  -o, --org=<value>  The Salesforce org to push form templates to.

    The target Salesforce org where the SharinPix form templates will be uploaded and stored.

sf sharinpix permission pull

Pull SharinPix permissions from Salesforce org.

USAGE
  $ sf sharinpix permission pull -o <value> [--json] [--flags-dir <value>]

FLAGS
  -o, --org=<value>  (required) The Salesforce org to pull SharinPix permissions from.

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

DESCRIPTION
  Pull SharinPix permissions from Salesforce org.

  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 [email protected]

FLAG DESCRIPTIONS
  -o, --org=<value>  The Salesforce org to pull SharinPix permissions from.

    The target Salesforce org containing the SharinPix permissions to be pulled.

sf sharinpix permission push

Push SharinPix permissions to Salesforce org.

USAGE
  $ sf sharinpix permission push -o <value> [--json] [--flags-dir <value>] [-d]

FLAGS
  -d, --delete       Delete SharinPix permissions from org that no longer have corresponding local files.
  -o, --org=<value>  (required) The Salesforce org to push SharinPix permissions to.

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

DESCRIPTION
  Push SharinPix permissions to Salesforce org.

  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.

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 [email protected]

  Push SharinPix permissions and delete orphaned records:

    $ sf sharinpix permission push --delete

FLAG DESCRIPTIONS
  -d, --delete  Delete SharinPix permissions from org that no longer have corresponding local files.

    When enabled, this flag will delete SharinPix permission records from the Salesforce org if their corresponding
    local JSON files are missing. Use with caution as this operation cannot be undone.

  -o, --org=<value>  The Salesforce org to push SharinPix permissions to.

    The target Salesforce org where the SharinPix permissions will be uploaded and stored.