solace-agent-mesh

<!-- Copyright Solace Corporation -->
<!-- SPDX-License-Identifier: BUSL-1.1 -->

# Solace Agent Mesh

[Solace Agent Mesh](https://solace.com/products/agent-mesh/) is an agent development and runtime platform. It supports the full agent development lifecycle: build, test, deploy, monitor, and improve your agents and business process workflows. It hosts the agents you build, runs the tools they call, and coordinates everything over an event broker, with sessions, artifacts, authentication, evaluators, and observability built in.

> [!NOTE]
> **The Solace Agent Mesh source code is coming to this repository soon.**
> Until then, this repository holds Agent Mesh Desktop downloads and
> ready-to-run examples.

## Installing Agent Mesh Desktop

Agent Mesh Desktop is free, runs as a single application on your computer, and
includes the `sam` command line interface (CLI).

To install the application, run the install command for your operating system.
The command downloads the application from the
[latest release](../../releases/latest).

Agent Mesh Desktop runs on the following platforms:

- macOS 11 (Big Sur) and later
- Windows 10 and later (x86_64)
- Linux (Experimental)

On macOS and Linux:

```sh
curl -fsSL https://raw.githubusercontent.com/SolaceProducts/solace-agent-mesh/main/install/install.sh | sh
```

On Windows, in PowerShell:

```powershell
irm https://raw.githubusercontent.com/SolaceProducts/solace-agent-mesh/main/install/install.ps1 | iex
```

The script selects the download that matches your operating system and
processor. On Linux, it also selects your package format and WebKitGTK version.
Before it installs anything, the script checks the download against the SHA-256
checksum of the release asset, and verifies the Apple notarization on macOS or
the Authenticode signature on Windows.

To preview what the script does without installing, run it with `--dry-run`. On
macOS and Linux, pass the flag through `sh -s --`:

```sh
curl -fsSL https://raw.githubusercontent.com/SolaceProducts/solace-agent-mesh/main/install/install.sh | sh -s -- --dry-run
```

On Windows, set `$env:SAM_INSTALL_DRY_RUN=1` instead.

You can also download the asset for your platform from the
[latest release](../../releases/latest) and install it yourself.

To connect an LLM the first time you open the application, see
[Installing the Desktop Bundle](https://docs.solace.com/Agent-Mesh/Framework/installing/desktop.htm).

## Using the `sam` CLI

To run `sam` from a terminal, add it to your `PATH` on Windows, or create an
alias on macOS and Linux:

- **On Windows:** The installer places `sam.exe` in
  `%LOCALAPPDATA%\Programs\Solace Agent Mesh\cli`, and the install script adds
  that folder to your user `PATH`. Open a new terminal to use `sam`. If you
  install without the script, add the folder yourself.
- **On macOS:** Add an alias:
  `alias sam='"/Applications/Solace Agent Mesh.app/Contents/MacOS/sam-desktop"'`
- **On Linux:** Add an alias: `alias sam='solace-agent-mesh'`