Simple SF CLI

Simple SF CLI is a Node.js-based command-line tool designed to simplify the conversion of Salesforce DX (SFDX) source format to Metadata API (MDAPI) format, zip the contents, and deploy them to Salesforce.

Features

• Convert SFDX source format to MDAPI format.
• Generate a package.xml for deployment.
• Exclude specific metadata components from deployment.
• Zip the converted MDAPI directory.
• Deploy zipped content to Salesforce using SOAP API.

Package Details

| Detail | Value | |-----------------------|---------| | Package Size | 9.6 kB | | Unpacked Size | 15.7 kB |

https://www.npmjs.com/package/simple-sf-cli

Why Use Simple SF CLI?

• No Salesforce CLI or Plugins Required: Unlike other tools, Simple SF CLI does not rely on Salesforce CLI (sfdx), Salesforce GitHub Deploy (sgd), or any other Salesforce-related plugins. Everything is customized and built from scratch.
• Fast Installation: The entire package can be installed in 3-5 seconds in GitHub Actions, making it ideal for CI/CD pipelines.

Installation

npm install -g simple-sf-cli

Usage

After installation, you can use the CLI tool as follows:

Basic Command

simple-sf-cli --source <sourceDir> --output <outputZip>

Exclude Specific Metadata Types

You can exclude specific metadata types from the deployment using the --exclude option:

simple-sf-cli --source <sourceDir> --output <outputZip> --exclude NamedCredential,Profile

Environment Variables

Ensure you have the following environment variables set in your .env file:

INSTANCE_URL=https://your-salesforce-instance.salesforce.com
ACCESS_TOKEN=your_salesforce_access_token

Example

simple-sf-cli --source ./experiment/force-app/main --output ./mdapi_output/deployment.zip --exclude Profile

This command will convert the SFDX source located in ./experiment/force-app/main to MDAPI format, exclude Profile metadata, zip the contents, and save the ZIP file to ./mdapi_output/deployment.zip.

License

This project is licensed under the MIT License - see the LICENSE file for details.