Skip to content

Installation

Get Moxxy installed on your system. Choose the method that works best for you.

The fastest way to get started:

bash
curl -fsSL https://raw.githubusercontent.com/moxxy-ai/moxxy/main/install.sh | bash

This script downloads the latest binary for your platform and installs it to /usr/local/bin/moxxy.

Requirements

Before installing, ensure you have:

RequirementPurpose
macOS / LinuxSupported operating systems
SQLite3Memory and data storage (usually pre-installed)
API KeyAn 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

bash
# 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/moxxy

Optional: WASM Runtime

To enable WASM sandboxed agents:

bash
rustup target add wasm32-wasip1
cd agent_runtime && cargo build --target wasm32-wasip1 --release && cd ..

Verify Installation

Check that Moxxy is installed correctly:

bash
moxxy --help

You should see the help output with available commands.

Run Diagnostics

Check your system for any missing dependencies:

bash
moxxy doctor

This 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:

bash
# 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 ~/.local

SQLite Not Found

On some Linux distributions, you may need to install SQLite development headers:

bash
# Ubuntu/Debian
sudo apt-get install libsqlite3-dev

# Fedora
sudo dnf install sqlite-devel

# macOS (usually pre-installed)
brew install sqlite

Node.js Not Found (Build from Source)

bash
# 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@18

Upgrading

To upgrade to the latest version:

bash
curl -fsSL https://raw.githubusercontent.com/moxxy-ai/moxxy/main/install.sh | bash

Your agents and data are stored in ~/.moxxy/ and will be preserved during upgrades.

Open source · Self-hosted · Data sovereign