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
Docker Alternative

Alternatively, you can use our pre-built Docker image to run SAM CLI commands without a local Python installation. This is useful for quick tasks or CI/CD environments.

To verify the installation using Docker, you can run:

docker run --rm solace/solace-agent-mesh:latest --version

This command pulls the latest image (if not already present) and executes solace-agent-mesh --version inside the container. The --rm flag ensures the container is removed after execution.

For more complex operations like building a project, you'll need to mount your project directory into the container. See the Quick Start guide for an example.

PlantUML Installation Guide

Note: Installing PlantUML on the local machine is required to create PlantUML diagrams. Without proper installation, the PlantUML functionality will not be available.

Installation Instructions

Linux

  • Ubuntu/Debian: sudo apt install plantuml
  • Fedora/RHEL: sudo dnf install plantuml
  • Arch Linux: sudo pacman -S plantuml

Windows

macOS

  • Using Homebrew: brew install plantuml
  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