Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getpioneer.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

  • Rust (2024 edition) — install via rustup
  • SQLite development headers (Linux: libsqlite3-dev)

​
Building

git clone https://github.com/pioneer/pioneer
cd pioneer
cargo build --workspace

​
Running the gateway

cargo run -p pioneer-gateway

​
Running the desktop app

cargo run -p pioneer-desktop --bin pioneer-app

​
Dev mode CLI

cargo run -p pioneer-cli --features dev --bin pioneer-dev -- status

​
Regenerating protocol schemas

After changing types in crates/protocol: 
./scripts/protocol/export.sh
Commit the updated schemas alongside the Rust changes.

​
Code style

cargo fmt --all          # format
cargo clippy --workspace # lint
cargo test --workspace   # test
CI runs all three. Format and clippy violations will block merge.

​
Pull requests

  • Keep PRs focused on a single concern
  • Update or add tests for changed behavior
  • If you change the protocol, regenerate schemas and include them in the PR