Repository navigation
Installation
This guide explains how to get AlphaForge running on your machine, either from source in development mode or as a production build.
| Tool | Version | Notes |
|---|---|---|
| Rust | stable | MSVC toolchain required on Windows (see below) |
| Node.js | 22+ | LTS recommended |
| pnpm | 9+ | Package manager for the monorepo |
AlphaForge is built with Tauri 2, which requires the Microsoft C++ Build Tools on Windows:
-
Install Visual Studio Build Tools.
-
During installation select the "Desktop development with C++" workload.
-
Install Rust via rustup and confirm the default MSVC toolchain is active:
rustup default stable-msvc rustc --version
Install the Xcode Command Line Tools:
xcode-select --installNote: the MVP does not include macOS notarization, so a Gatekeeper warning when opening a downloaded build is a known, expected behavior (see Troubleshooting).
Install the Tauri system dependencies for your distribution (webkit2gtk, gtk3, and related packages).
git clone https://github.com/BerryUIKI/alpha-forge.git
cd alpha-forgepnpm installThis installs dependencies for the desktop app, shared packages, and internal plugins in one pass.
pnpm tauri devThis starts the Vite frontend and the Rust backend together, then opens the native desktop window. The first Rust build takes several minutes.
pnpm dev:webThe web frontend is useful for UI work but native features (filesystem, credentials, SQLite) are only available in the desktop app.
pnpm tauri buildPlatform installers are produced in apps/desktop/src-tauri/target/release/
(e.g. .msi/.exe on Windows, .dmg/.app on macOS, .deb/.AppImage on
Linux).
pnpm typecheck # TypeScript type checking
pnpm lint # ESLint
pnpm test # Frontend unit tests (Vitest)
cargo check --workspace
cargo fmt --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test --workspaceAll data is stored locally in a SQLite database inside the app's user data
directory (platform-specific, e.g. %APPDATA% on Windows, ~/Library/Application Support on macOS). See Configuration for backup and export options.
- Configuration — language and AI provider.
- Daily-Operations — the daily workflow.
AlphaForge — desktop-first AI workspace for investment research. Licensed under AGPL-3.0.