Supercharge Your Salesforce Deployments in Just Seconds!
Say goodbye to additional dependencies and complex configurations.
Use it directly with npx - no local installations needed.
Set up in 3-5 seconds, making it perfect for CI/CD pipelines.
With just 4 dependencies, fully customized for reliability and speed.
npx simple-sf-cli \
--source $CLI_SOURCE \
--exclude $CLI_EXCLUDE \
--clientId $CLIENT_ID \
--privateKey $PRIVATE_KEY \
--username $USER_NAME \
--validateOnly true \
--env PRODUCTION
npm install -g simple-sf-cli
| Option | Description | Example |
|---|---|---|
--username* |
Salesforce username | user@example.com or user@example.com.sandbox |
--clientId* |
Salesforce client ID | 3MVG9XXXXXXXXX |
--privateKey* |
Path to Salesforce private key | ./keys/private.key |
--env* |
Environment type (e.g., SANDBOX [default], PRODUCTION) | PRODUCTION |
--source |
Path to the SFDX source directory | force-app/main/default |
--validateOnly |
Validates without metadata deployment | true |
--exclude |
List of metadata types to exclude | NamedCredentials,Workflow |
--testLevel |
Specifies which tests are run as part of a deployment | NoTestRun,RunLocalTests, RunAllTests,RunSpecifiedtests |
name: SimpleSfCli CI
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{github.event.pull_request.head.sha}}
fetch-depth: 2
- run: git checkout HEAD^
- name: Deploy to Salesforce
run: |
- npx simple-sf-cli \
--source ${{secrets.SOURCE}} \
--exclude ${{secrets.EXCLUDE}} \
--clientId ${{secrets.CLIENT_ID}} \
--privateKey ${{secrets.PRIVATE_KEY}} \
--username ${{secrets.USER_NAME}} \
--validateOnly ${{secrets.VALIDATION}}
image:
name: node
pipelines:
pull-requests:
'**':
- step:
name: "Validate PR with SF CLI"
script:
- npx simple-sf-cli \
--source $CLI_SOURCE \
--exclude $CLI_EXCLUDE \
--clientId $CLIENT_ID \
--privateKey $PRIVATE_KEY \
--username $USER_NAME \
--validateOnly true
COMING SOON
COMING SOON