Skip to content

Installation

Stratum runs on Linux, macOS, and Windows. There are several ways to get it:

Download a Release

Pre-built binaries are available on the GitHub Releases page.

Platform Format File
Linux AppImage stratum-pkm-linux.AppImage
Linux Debian stratum-pkm-linux.deb
Linux RPM stratum-pkm-linux.rpm
Windows Portable exe stratum-pkm-windows.exe
macOS App bundle stratum-pkm-macos.zip
Android APK / AAB stratum-pkm-android.apk / stratum-pkm-android.aab

Every release ships a sha256sums.txt with checksums for all artifacts.

Linux Dependencies

The AppImage bundles most dependencies. For other Linux formats you need WebKitGTK libraries: 

# Debian/Ubuntu
sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libsoup-3.0-dev                      libjavascriptcoregtk-4.1-dev librsvg2-dev

# Arch Linux
sudo pacman -S webkitgtk-4.1 gtk3 libsoup3 librsvg

Build from Source

Prerequisites

# Clone the repository
git clone https://github.com/short-circuit/stratum.git
cd stratum

# Enter the Nix dev shell (all dependencies included)
nix develop ./nix

# Or use direnv for automatic activation
direnv allow

# Build everything
cargo build --workspace
cargo test --workspace
npm install
npm run build

Manual Build

git clone https://github.com/short-circuit/stratum.git
cd stratum

# Install frontend dependencies
npm install

# Build Rust crates
cargo build --workspace

# Run tests (optional but recommended)
cargo test --workspace

Running the Desktop App

# Development mode (hot-reload)
npm run tauri:dev

# Production build
npm run tauri:build

The built app is in src-tauri/target/release/stratum.

Environment Variables

Stratum uses some environment variables for Wayland compatibility:

# If you encounter display issues on Linux/ Wayland:
export WEBKIT_DISABLE_DMABUF_RENDERER=1
export WEBKIT_DISABLE_COMPOSITING_MODE=1

# Or use the provided npm scripts:
npm run tauri:dev:x11  # Force X11 backend

Using the CLI

The CLI binary is built alongside the desktop app:

cargo run -p pkm-cli -- --help

Or build it separately:

cargo build -p pkm-cli
./target/debug/stratum --help

See the CLI Reference for all commands.

Using the MCP Server

To expose your vault to external AI clients over the Model Context Protocol, build and run the pkm-mcp binary:

cargo build -p pkm-mcp
./target/debug/pkm-mcp --vault /path/to/your/vault

For transports, configuration, authentication, the full tool list, and troubleshooting, see the MCP Server guide.