@salesforce/source-deploy-retrieve
v12.10.2
Published
JavaScript library to run Salesforce metadata deploys and retrieves
Downloads
974,431
Maintainers
Readme
Salesforce source-deploy-retrieve
Introduction
A JavaScript toolkit for working with Salesforce metadata. Built to support the Salesforce CLI deploy and retrieve experience in the Salesforce VS Code Extensions, CLI plugins, and other tools working with metadata.
Features
- Resolve Salesforce metadata files into JavaScript objects
- Parse and generate manifest files
- Convert source files between SFDX File Formats
- Generate metadata packages with the option to automatically create a zip file
- Deploy and retrieve metadata with an org
- An index to reference available metadata types.
- Utilize promises with
async/await
syntax
Issues
Please report all issues to the issues only repository.
Usage
Install the package:
npm install @salesforce/source-deploy-retrieve
See HANDBOOK.md for usage and examples.
See API Docs
Contributing
See CONTRIBUTING.md for details on how to contribute to the library.
See developing.md for details on building and testing the library locally.
Publishing
SDR publishes when changes are merged into main
. The version is bumped per the rules of the release orb and standard-version.