Skip to main content

Prerequisites

Before you begin, make sure you have the following:

  • Python 3.10.16+
  • pip (usually included with Python)
  • Operating System: macOS, Linux, or Windows (via WSL)
  • LLM API key from any major provider or your own custom endpoint.

Installation

Solace Agent Mesh Module comes with two components:

  1. Solace Agent Mesh (SAM) CLI: To create, build, run, and extend Solace Agent Mesh.
  2. Solace Agent Mesh framework: A Python-based framework that you can build upon to customize and extend the capabilities of Solace Agent Mesh.

Installing the PyPi package will install both the SAM CLI and the framework (which is built on the Python SDK).

tip

We recommend that you install the package in a virtual environment to avoid conflicts with other Python packages.

Creating a Virtual Environment
  1. Create a virtual environment.
python3 -m venv .venv

  1. Activate the environment.

    To activate on Linux or Unix platforms:

    source .venv/bin/activate

    To activate on Windows:

    .venv\Scripts\activate

Install Solace Agent Mesh

  1. The following command installs the Solace Agent Mesh (SAM) CLI in your environment:
pip install solace-agent-mesh
Windows-Specific Setup

PlantUML Support

The functionality from PlantUML is not available on Windows. To use PlantUML on Windows, we recommend you install SAM on Windows Subsystem for Linux (WSL).

Plotly Support

Windows Users: To enable Plotly visualization capabilities, you must install a specific version of the Kaleido package before launching the application:

pip install --upgrade "kaleido==0.1.*"

This step is required only for Windows environments.

  1. Run the following SAM CLI command (solace-agent-mesh) to verify your installation:
solace-agent-mesh --version
tip

For easier access to the SAM CLI, it also comes with the sam alias.

sam --version

To get the list of available commands, run:

solace-agent-mesh --help