Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Prerequisites

RUSVEL is a Rust + SvelteKit application. You need the following installed:

DependencyVersionRequiredPurpose
RustEdition 2024 (nightly or stable 1.85+)YesBackend, all engines
Node.js20+YesFrontend build
pnpm9+YesFrontend package manager
SQLite3.35+BundledDatabase (WAL mode)
OllamaLatestOptionalLocal LLM inference

Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Install Node.js + pnpm

Use your preferred method (nvm, fnm, or direct install):

# With nvm
nvm install 22
nvm use 22

# Install pnpm
corepack enable
corepack prepare pnpm@9.15.4 --activate
# Or: npm install -g pnpm

Install Ollama (optional)

Ollama provides free local LLM inference. RUSVEL auto-detects it on first run.

# macOS
brew install ollama

# Linux
curl -fsSL https://ollama.com/install.sh | sh

# Start the service
ollama serve

If you skip Ollama, you can configure Claude API or OpenAI keys instead.

Clone and Build

git clone https://github.com/mbaneshi/rusvel.git
cd rusvel
cargo build

The workspace has 50 members (see Repository status). First build takes a few minutes; subsequent builds are incremental.

Build the Frontend

cd frontend
pnpm install
pnpm build

The built frontend is served by the Rust binary at runtime. During development you can run pnpm dev for hot-reload on port 5173.

Verify the Installation

Run the full test suite to confirm everything works:

cargo test

You should see on the order of ~399 tests passing (exact count changes over time). Use cargo test exit code 0 as the gate.

test result: ok. … passed; 0 failed

Test individual crates

cargo test -p rusvel-core       # Core domain types and port traits
cargo test -p rusvel-db         # SQLite stores (41 tests)
cargo test -p forge-engine      # Agent orchestration (15 tests)
cargo test -p content-engine    # Content creation (7 tests)
cargo test -p harvest-engine    # Opportunity discovery (12 tests)

Next Steps

Once installed, proceed to First Run to launch RUSVEL for the first time.