# @salesforce/source-deploy-retrieve

> JavaScript library to run Salesforce metadata deploys and retrieves

Latest version **13.4.2** (published 2026-09-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @salesforce/source-deploy-retrieve
pnpm add @salesforce/source-deploy-retrieve
yarn add @salesforce/source-deploy-retrieve
bun add @salesforce/source-deploy-retrieve
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 13.4.2 |
| Published | 2026-09-29 |
| First published | 2020-04-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=22.0.0 |
| Dependencies | 14 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 97 |
| Author | Salesforce |
| Maintainers | ire-npm-team-user, jimjag, salesforce-releases, jasonschroeder-sfdc, mobify, lwc-admin, salesforce-admin |
| Keywords | Salesforce, SalesforceDX, metadata, deploy, retrieve |

## Links

- npm: https://www.npmjs.com/package/@salesforce/source-deploy-retrieve
- Repository: https://github.com/forcedotcom/source-deploy-retrieve
- Homepage: https://github.com/forcedotcom/source-deploy-retrieve#readme
- Issues: https://github.com/forcedotcom/source-deploy-retrieve/issues
- npm.io page: https://npm.io/package/@salesforce/source-deploy-retrieve

## Dependencies (14)

- [got](https://npm.io/package/got.md) ^11.8.6
- [mime](https://npm.io/package/mime.md) 2.6.0
- [yaml](https://npm.io/package/yaml.md) ^2.9.0
- [jszip](https://npm.io/package/jszip.md) ^3.10.1
- [ignore](https://npm.io/package/ignore.md) ^5.3.2
- [minimatch](https://npm.io/package/minimatch.md) ^9.0.9
- [graceful-fs](https://npm.io/package/graceful-fs.md) ^4.2.11
- [proxy-agent](https://npm.io/package/proxy-agent.md) ^6.5.0
- [@salesforce/kit](https://npm.io/package/@salesforce/kit.md) ^4.0.0
- [fast-xml-parser](https://npm.io/package/fast-xml-parser.md) ^5.7.3
- [@salesforce/core](https://npm.io/package/@salesforce/core.md) ^9.2.2
- [fast-levenshtein](https://npm.io/package/fast-levenshtein.md) ^3.0.0
- [@salesforce/types](https://npm.io/package/@salesforce/types.md) ^1.6.0
- [@salesforce/ts-types](https://npm.io/package/@salesforce/ts-types.md) ^3.2.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 13.4.2 (latest) — 2026-09-29
- 13.3.1-qa.0 (qa) — 2026-08-31
- 12.31.3-dev.0 (dev) — 2026-01-09
- 12.14.4-csb.0 (csb) — 2025-02-06
- 7.14.3-beta.1 (beta) — 2023-04-04
- 5.0.0-orb.5 (pubtest) — 2021-08-24
- 13.4.1 — 2026-09-28
- 13.4.0 — 2026-09-17
- 13.3.4 — 2026-09-16
- 13.3.3 — 2026-09-16
- 13.3.2 — 2026-09-11
- 13.3.1 — 2026-09-04
- 13.3.0 — 2026-08-25
- 13.2.3 — 2026-08-24
- 13.2.2 — 2026-08-24
- … 635 more at https://npm.io/package/@salesforce/source-deploy-retrieve/versions

## 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).

---
_Source: https://npm.io/package/@salesforce/source-deploy-retrieve · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
