https://github.com/forcedotcom/source-deploy-retrieve

JavaScript toolkit for working with Salesforce metadata.
https://github.com/forcedotcom/source-deploy-retrieve

Last synced: about 2 months ago
JSON representation

JavaScript toolkit for working with Salesforce metadata.

• Host: GitHub
• URL: https://github.com/forcedotcom/source-deploy-retrieve
• Owner: forcedotcom
• License: apache-2.0
• Created: 2020-03-06T00:44:51.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2026-05-07T01:23:49.000Z (about 2 months ago)
• Last Synced: 2026-05-07T03:21:55.855Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 82.4 MB
• Stars: 91
• Watchers: 12
• Forks: 164
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# Salesforce source-deploy-retrieve

[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)

![npm (scoped)](https://img.shields.io/npm/v/@salesforce/source-deploy-retrieve)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## 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](https://github.com/forcedotcom/salesforcedx-vscode), CLI plugins, and other tools working with metadata.

## Features

- Resolve Salesforce metadata files into JavaScript objects

- Parse and generate [manifest files](https://trailhead.salesforce.com/en/content/learn/modules/package-xml/package-xml-adventure)

- Convert source files between [SFDX File Formats](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_source_file_format.htm)

- Generate metadata packages with the option to automatically create a zip file

- Deploy and retrieve metadata with an org

- An [index](./src/registry/metadataRegistry.json) to reference available metadata types.

- Utilize promises with `async/await` syntax

## Issues

Please report all issues to the [issues only repository](https://github.com/forcedotcom/cli/issues).

## Usage

Install the package:

```

npm install @salesforce/source-deploy-retrieve

```

See [HANDBOOK.md](./HANDBOOK.md) for usage and examples.

See [API Docs](https://forcedotcom.github.io/source-deploy-retrieve)

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute to the library.

See [developing.md](./contributing/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](https://github.com/conventional-changelog/standard-version).