# @salesforce/agents

> Client side APIs for working with Salesforce agents

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

## Install

```sh
npm install @salesforce/agents
pnpm add @salesforce/agents
yarn add @salesforce/agents
bun add @salesforce/agents
```

## Health

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

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

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.3.1 |
| Published | 2026-09-09 |
| First published | 2024-11-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=22.0.0 |
| Dependencies | 6 |
| Unpacked size | 637 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | Salesforce |
| Maintainers | ire-npm-team-user, jimjag, salesforce-releases, jasonschroeder-sfdc, mobify, lwc-admin, salesforce-admin |
| Keywords | force, salesforce, salesforcedx, sf, sfdx, agents, agentforce, ai |

## Links

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

## Dependencies (6)

- [yaml](https://npm.io/package/yaml.md) ^2.8.4
- [@salesforce/kit](https://npm.io/package/@salesforce/kit.md) ^4.0.0
- [fast-xml-parser](https://npm.io/package/fast-xml-parser.md) ^5.8.0
- [@salesforce/core](https://npm.io/package/@salesforce/core.md) ^9.0.0
- [@salesforce/types](https://npm.io/package/@salesforce/types.md) ^1.8.0
- [@salesforce/source-deploy-retrieve](https://npm.io/package/@salesforce/source-deploy-retrieve.md) ^13.1.1

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 2.3.1 (latest) — 2026-09-09
- 0.25.2-tdx26.0 (tdx26) — 2026-04-14
- 0.21.2-beta.2 (beta) — 2026-01-23
- 0.18.3-nga.8 (nga) — 2025-12-03
- 0.14.14-dev.0 (dev) — 2025-05-13
- 0.14.9-preview.5 (preview) — 2025-05-07
- 2.3.0 — 2026-09-08
- 2.2.0 — 2026-09-01
- 2.1.1 — 2026-08-28
- 2.1.0 — 2026-08-27
- 2.0.6 — 2026-08-24
- 2.0.5 — 2026-08-19
- 2.0.4 — 2026-08-18
- 2.0.3 — 2026-08-18
- 2.0.2 — 2026-08-14
- … 221 more at https://npm.io/package/@salesforce/agents/versions

## README

# Salesforce Agents - BETA

---

### :warning: All APIs are beta. :warning:

---

[![NPM](https://img.shields.io/npm/v/@salesforce/agents.svg?label=@salesforce/agents)](https://www.npmjs.com/package/@salesforce/agents) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/agents.svg)](https://www.npmjs.com/package/@salesforce/agents) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)

## Introduction

A Typescript toolkit for working with Salesforce Agentforce Agents. Built to support the Salesforce CLI, VSCode Extensions, DevOps Center, and any other node/typescript projects aimed at Agents.

## Features

- Create Agents
- Create Agent Specs
- Interact with Agents
- Run Agent Tests
- Publish Agents
- Activate/Deactivate Agents

## Usage

Install the package:

```
npm install @salesforce/agents
```

See [API Docs](https://forcedotcom.github.io/agents)

## Contributing

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

See [DEVELOPING](./DEVELOPING.md) for details on building and testing the library locally.

## Publishing

`@salesforce/agents` 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/agents · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._