Installation
Get Moxxy installed on your system. Choose the method that works best for you.
Quick Install (Recommended)
The fastest way to get started:
curl -fsSL https://raw.githubusercontent.com/moxxy-ai/moxxy/main/install.sh | bashThis script downloads the latest binary for your platform and installs it to /usr/local/bin/moxxy.
Requirements
Before installing, ensure you have:
| Requirement | Purpose |
|---|---|
| macOS / Linux | Supported operating systems |
| SQLite3 | Memory and data storage (usually pre-installed) |
| API Key | An LLM provider API key (OpenAI, Google, or Z.Ai) |
TIP
Moxxy runs entirely locally. Your data never leaves your machine unless you explicitly configure external integrations.
Build from Source
For developers or if you want the latest features:
Prerequisites
- Rust (edition 2024) - Install Rust
- Node.js (v18+) - Required for the web dashboard frontend
- wasm32-wasip1 target (optional) - For WASM agent runtime
Build Steps
# Clone the repository
git clone https://github.com/moxxy-ai/moxxy.git
cd moxxy
# Build the frontend (required before backend)
cd frontend && npm install && npm run build && cd ..
# Build the backend
cargo build --release
# The binary will be at ./target/release/moxxyOptional: WASM Runtime
To enable WASM sandboxed agents:
rustup target add wasm32-wasip1
cd agent_runtime && cargo build --target wasm32-wasip1 --release && cd ..Verify Installation
Check that Moxxy is installed correctly:
moxxy --helpYou should see the help output with available commands.
Run Diagnostics
Check your system for any missing dependencies:
moxxy doctorThis will verify:
- SQLite3 is available
- Required directories can be created
- Configuration files are accessible
Next Steps
Once installed, run the first-time setup to configure your LLM provider and create your first agent.
Troubleshooting
Permission Denied
If you get permission errors during installation:
# Run with sudo
curl -fsSL https://raw.githubusercontent.com/moxxy-ai/moxxy/main/install.sh | sudo bash
# Or install to user directory
curl -fsSL https://raw.githubusercontent.com/moxxy-ai/moxxy/main/install.sh | bash -s -- --prefix ~/.localSQLite Not Found
On some Linux distributions, you may need to install SQLite development headers:
# Ubuntu/Debian
sudo apt-get install libsqlite3-dev
# Fedora
sudo dnf install sqlite-devel
# macOS (usually pre-installed)
brew install sqliteNode.js Not Found (Build from Source)
# Using nvm (recommended)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 18
nvm use 18
# Using Homebrew (macOS)
brew install node@18Upgrading
To upgrade to the latest version:
curl -fsSL https://raw.githubusercontent.com/moxxy-ai/moxxy/main/install.sh | bashYour agents and data are stored in ~/.moxxy/ and will be preserved during upgrades.