wheel-installation.md
1 --- 2 title: Running from Wheel File 3 sidebar_position: 6 4 --- 5 6 # Running Agent Mesh Enterprise from Wheel File 7 8 You can run Agent Mesh Enterprise directly from a Python wheel file without using Docker containers. This approach gives you direct control over your Python environment and integrates with existing Python-based deployments. 9 10 ## Prerequisites 11 12 To run Agent Mesh Enterprise from a wheel file, you need: 13 14 - Python 3.10.16 – 3.13.x 15 - pip or uv package manager 16 - Access to the [Solace Product Portal](https://products.solace.com/prods/Agent_Mesh/Enterprise/) 17 - An LLM service API key and endpoint (optional—you can configure models through the Agent Mesh UI after starting the application) 18 - For production deployments, Solace broker credentials 19 20 ## Step 1: Download the Wheel File 21 22 Download the Agent Mesh Enterprise wheel file from the [Solace Product Portal](https://products.solace.com/prods/Agent_Mesh/Enterprise/). 23 24 The wheel file follows the naming pattern: 25 ``` 26 solace_agent_mesh_enterprise-<version>-py3-none-any.whl 27 ``` 28 29 ## Step 2: Install the Wheel File 30 31 You can install the wheel file with either pip or uv. 32 33 If you use pip, run: 34 ```bash 35 pip install solace_agent_mesh_enterprise-<version>-py3-none-any.whl 36 ``` 37 38 If you use uv, run: 39 ```bash 40 uv pip install solace_agent_mesh_enterprise-<version>-py3-none-any.whl 41 ``` 42 43 This installation provides the `solace-agent-mesh` CLI tool and the Agent Mesh Enterprise framework. 44 45 ## Step 3: Prepare Your Configuration 46 47 Agent Mesh Enterprise requires configuration files that define your agents, gateways, and system settings. The `solace-agent-mesh init` command creates the project directory structure, environment variables, and configuration files you need. 48 49 Follow the project setup steps in the [Creating and Running an Agent Mesh Project](../installing-and-configuring/run-project.md#create-your-project) guide to initialize your configuration. You can use the web-based interface or command-line options to configure your project settings. 50 51 After initialization, your project directory contains the necessary `configs/` directory with agent and gateway configurations, plus a `.env` file with your credentials. 52 53 ## Step 4: Run Agent Mesh Enterprise 54 55 Start Agent Mesh Enterprise using the `solace-agent-mesh run` command: 56 57 ```bash 58 solace-agent-mesh run 59 ``` 60 61 This command loads environment variables from your `.env` file, starts all agents and gateways defined in your `configs/` directory, and launches the web UI if you configured one. 62 63 ### Running Specific Components 64 65 To run only specific agents or gateways, provide the configuration files as arguments: 66 67 ```bash 68 solace-agent-mesh run configs/agents/orchestrator.yaml configs/gateways/webui.yaml 69 ``` 70 71 ### Using the Short Alias 72 73 The `sam` alias provides a shorter alternative to the full command name: 74 75 ```bash 76 sam run 77 ``` 78 79 ## Limitations 80 81 When running from a wheel file, certain features have limitations compared to the Docker-based deployment. 82 83 ### No Dynamic Agent Deployment 84 85 Dynamic agent deployment through the UI or API is not supported when running from a wheel file. You cannot deploy new agents at runtime through the web interface, upload agent configurations through the API, or dynamically add or remove agents without restarting. All agents must be defined in configuration files before you start the application. 86 87 ### Custom Agent Code 88 89 To create custom agents with Python tools and lifecycle functions, follow the standard agent creation process. For detailed instructions on creating agents with custom code, see [Creating Agents](../developing/create-agents.md). 90 91 ## Accessing the Web UI 92 93 After starting Agent Mesh Enterprise, access the web interface at the configured port (default: `http://localhost:8000`). 94 95 If you specified a different port in your gateway configuration, use that port instead. 96 97 ## Next Steps 98 99 After running Agent Mesh Enterprise from the wheel file, you can configure authentication and authorization for your deployment. For information about setting up authentication, see [Single Sign-On](./single-sign-on.md). For information about configuring authorization, see [Role-Based Access Control](./rbac-setup-guide.md). For production deployment considerations, see [deployment options](../deploying/deployment-options.md).