Skip to main content

​
System Requirements

Before installing Solace Agent Mesh, ensure your system meets the following requirements:
  • Python 3.10.16 or higher
  • pip (comes with Python)
  • Operating System: macOS, Linux, or Windows with WSL
  • LLM API key (OpenAI, Anthropic, or any LiteLLM-compatible provider)
  • Optional: Docker or Podman (for running a local Solace broker)

​
Installation Steps

1

Create a Project Directory

Create a new directory for your Solace Agent Mesh project:
mkdir my-sam-project && cd my-sam-project
2

Set Up Python Virtual Environment

Create and activate a Python virtual environment to isolate your project dependencies:
python3 -m venv .venv
source .venv/bin/activate
Your terminal prompt should change to indicate the virtual environment is active (e.g., (.venv)).
3

Check for Existing Installation

Before installing, check if you have an existing version of Solace Agent Mesh:
sam -v
If you have an earlier version installed, it’s recommended to uninstall it and start fresh:
pip3 uninstall solace-agent-mesh
Upgrading from an older version using pip3 install --upgrade is not officially supported. Always start with a clean installation.
4

Install Solace Agent Mesh

Install the latest version of Solace Agent Mesh using pip:
pip3 install solace-agent-mesh
This will install the solace-agent-mesh package and all its dependencies, including:
  • Google Agent Development Kit (ADK)
  • Solace AI Connector
  • LiteLLM for LLM integration
  • FastAPI and Uvicorn for web interfaces
  • And many more (see pyproject.toml for full list)
5

Verify Installation

Verify that the installation was successful:
sam --version
You should see output similar to:
solace-agent-mesh: 0.x.x
6

Install Playwright (Required)

Solace Agent Mesh uses Playwright for certain web-based features. After installation, run:
playwright install
This installs the necessary browser binaries for Playwright to function.

​
Optional Dependencies

Solace Agent Mesh supports optional feature sets that can be installed separately:

​
Vertex AI Integration

If you plan to use Google Cloud Vertex AI: 
pip3 install solace-agent-mesh[vertex]

​
Development and Testing

For development work or running tests: 
pip3 install solace-agent-mesh[test]
This includes:
  • pytest and testing utilities
  • Code quality tools (ruff)
  • Additional testing dependencies

​
Installation Using Hatch

For developers working on Solace Agent Mesh itself, you can use Hatch for dependency management: 
# Install hatch
pip install hatch

# Run tests with hatch
hatch test

# Run tests with specific Python version
hatch test --python 3.10

​
Verifying Your Installation

After installation, verify that all components are working: 
sam --help
You should see a list of available commands including:
  • init - Initialize a new project
  • run - Run your agent mesh
  • add - Add agents, gateways, or proxies
  • plugin - Manage plugins
  • eval - Run evaluations
  • docs - Access documentation

​
Next Steps

Now that you have Solace Agent Mesh installed, you’re ready to:
  1. Initialize your first project
  2. Set up a Solace broker
  3. Configure environment variables

​
Troubleshooting

​
Python Version Issues

If you encounter Python version errors: 
# Check your Python version
python3 --version

# Ensure it's 3.10.16 or higher

​
Permission Errors

If you get permission errors during installation: 
# Use --user flag
pip3 install --user solace-agent-mesh

​
Virtual Environment Not Activating

On some systems, you may need to use: 
# Alternative activation method
. .venv/bin/activate

​
Playwright Installation Issues

If Playwright fails to install browsers: 
# Install with sudo (Linux)
sudo playwright install

# Or install specific browsers
playwright install chromium

Build docs developers (and LLMs) love

Get started for freeTalk to us