Installation
Install SREGym and set up your development environment with all required dependencies
Requirements
Before installing SREGym, ensure you have the following prerequisites:
- Python >= 3.12
- Helm - Kubernetes package manager
- brew - Package manager for macOS/Linux
- kubectl - Kubernetes command-line tool
- uv - Fast Python package installer and resolver
- kind - Kubernetes in Docker (if running locally)
Recommendations
These tools are not required but recommended for a better development experience:
- MCP Inspector - Test MCP tools before integrating into your agent
- k9s - Terminal UI to observe and manage your Kubernetes cluster
Installation Steps
-
Clone the repository with submodules:
git clone --recurse-submodules https://github.com/SREGym/SREGym cd SREGym -
Install dependencies using uv:
uv sync -
Install pre-commit hooks to ensure code quality:
uv run pre-commit install
Next Steps
Once installation is complete:
- Cluster Setup - Set up your Kubernetes cluster (Emulated cluster or full cluster)
- Quick Start - Run your first agent
- Troubleshooting - Troubleshooting guide if you encounter problems