Installing Matrix OS
Get Matrix OS up and running on your system in minutes. Follow our step-by-step guide for a smooth installation experience.
System Requirements
Hardware Requirements
- CPU: 64-bit processor, 2 cores minimum
- RAM: 4GB minimum (8GB recommended)
- Storage: 1GB free space
- Network: Stable internet connection
Software Requirements
- OS: Linux, macOS, or Windows 10/11
- Python: 3.8 or higher
- Node.js: 16.x or higher
- Git: 2.x or higher
Installation Methods
Using Package Managers (Recommended)
macOS (Homebrew)
Install via Homebrew
brew install matrix-os
Linux (apt)
Install via apt
# Add Matrix OS repository
curl -fsSL https://matrix.os/gpg | sudo gpg --dearmor -o /usr/share/keyrings/matrix-os-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/matrix-os-archive-keyring.gpg] https://repo.matrix.os stable main" | sudo tee /etc/apt/sources.list.d/matrix-os.list
# Install Matrix OS
sudo apt update
sudo apt install matrix-os
Windows (winget)
Install via winget
winget install matrix-os
Manual Installation
If you prefer manual installation or your system doesn't support package managers, you can download and install Matrix OS directly from our GitHub releases.
Linux/macOS
Manual installation steps
# Download the latest release
curl -LO https://github.com/matrix-os/matrix-os/releases/latest/download/matrix-os-$(uname -s)-$(uname -m).tar.gz
# Extract and install
tar xzf matrix-os-*.tar.gz
cd matrix-os-*
sudo ./install.sh
Post-Installation Setup
Verify Installation
After installation, verify that Matrix OS is properly installed by checking the version:
Check version
matrix-os --version
Initial Configuration
Configure your Matrix OS installation with the interactive setup wizard:
Run setup wizard
matrix-os setup
Next Steps
Now that you have Matrix OS installed, you can:
- Follow our Quick Start Guide to create your first agent
- Learn about configuration options