Matchstick Documentation Preview

These notes bridge the gap while the dedicated docs portal launches. Use them to prep internal reviews, waitlist updates, and contributor onboarding.

Join the Waitlist View GitHub Roadmap
Install Preview Binaries ship with the beta — commands ready today

CLI + TUI Setup (Beta Day 0)

Rust Path

cargo install matchstick-cli
matchstick init my-playbook
matchstick run --replay sample-data

Ships as a signed crate. CI enforces cargo fmt/cargo clippy so checks pass on contributor PRs.

Binary Releases

  • macOS `.pkg`, Linux `.deb`/`.rpm`, Windows `.msi` published from GitHub Actions.
  • Checksums + SBOMs drop alongside each tag for security reviews.
  • npm install -g matchstick-cli lands right after beta for JS tooling.
Need assets for the landing page? Drop `cli-demo.png`, `tui-session.png`, or `preview.mp4` in public/assets/demo and the home page updates automatically.
Architecture at a Glance Matchstick is a hybrid Rust + pnpm workspace

Key Packages

Rust Workspace

  • matchstick-cli — developer CLI, scaffolding, replay tools.
  • matchstick-engine — low-latency core, Cap'n Proto RPC.
  • matchstick-tui — terminal dashboard streaming simulated data.

TypeScript Workspace

  • matchstick-site — Astro marketing surface with waitlist + demo slots.
  • matchstick-web — Cap'n Web layer (in progress).
  • forge — docs + PRD automation CLI.

Full architecture diagrams live in docs/reference/ARCHITECTURE.md and the README roadmap.

Need a guided walk-through? Start with the build log for weekly implementation notes.

Roadmap Signals Updates drop every 2-4 weeks

Milestones Toward Beta (Q4 2025)

v0.1 Demo Drop

  • CLI scaffolding + interactive REPL.
  • TUI market replay and risk gauges.
  • Feedback intake wired to waitlist.

v0.3 Engine Preview

  • Cap'n Proto RPC and tiered storage adapters.
  • Replay harness for deterministic regression testing.
  • Programmable risk + metrics DSL.

v1.0 Launch

  • Signed binaries with auto-update channels.
  • Strategy plugin marketplace + showcase.
  • Runbooks for desks deploying across regions.
Follow progress in GitHub and drop roadmap requests through the contact form.

Additional Resources

For Evaluators

For Contributors