@salesforce/agents/README.md

Client side APIs for working with Salesforce agents

# 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://npmjs.org/package/@salesforce/agents) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/forcedotcom/agents/main/LICENSE.txt)

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

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