Quickstart Guide
Getting Started with NucleusFlow
Install the standalone CLI or embed the Rust crate in under five minutes.
1. Prerequisites & Toolchain Floor
NucleusFlow requires Rust 1.89.0 or later (2021 Edition). The Minimum Supported Rust Version (MSRV) is enforced at compile time via Cargo.toml (rust-version = "1.89.0") and build.rs.
2. Installation
As a Rust Library Dependency
Add nucleusflow to your project's Cargo.toml:
[dependencies]
nucleusflow = "0.0.11"
Or run cargo add:
As a Standalone Command-Line Binary
Install the nucleusflow CLI directly from Crates.io:
System Package Managers & Containers
NucleusFlow ships native packaging definitions across major operating systems in the upstream repository (pkg/):
| Channel | Command / Manifest | Notes |
|---|---|---|
| Cargo | cargo install nucleusflow --locked | Builds from source with Rust 1.89.0+ |
| Homebrew | brew install pkg/brew/nucleusflow.rb | macOS & Linux formula |
| Nix Flakes | nix run github:sebastienrousseau/nucleusflow | Reproducible flake (pkg/nix/flake.nix) |
| Arch Linux (AUR) | makepkg -si in pkg/aur/ | Builds from signed release tarball |
| Debian / Ubuntu | dpkg-buildpackage -us -uc -b | Includes binary, manpage nucleusflow.1, completions |
| Fedora / RHEL | rpmbuild -ba pkg/rpm/nucleusflow.spec | RPM spec with manpage and shell completions |
| GNU Make | make install PREFIX=/usr/local | Installs binary, manpage, and bash/zsh/fish/pwsh completions |
3. CLI Quick Start
Step 1: Scaffold a New Site
Create a new project directory using one of the built-in starter templates (blog, docs, or portfolio):
This creates a standard directory layout with content/, templates/, public/, and nucleusflow.toml.
Step 2: Build the Static Site
Compile all Markdown files in content/ through your Handlebars layouts in templates/ and write minified HTML5 to public/:
Step 3: Preview Locally with Live Watch
Start the local development server on port 3000 with automatic file watching:
4. Rust Library Quick Start
End-to-End Pipeline (NucleusFlow)
Combine ContentProcessor, HandlebarsRenderer, and HtmlGenerator behind the top-level NucleusFlow orchestrator:
use ;
Standalone Markdown & Frontmatter Processing
You can also invoke individual pipeline stages directly without running a full directory build:
use Processor;
use MarkdownProcessor;
5. Next Steps
- Supported Formats: Explore CommonMark + GFM extensions, YAML 1.2 frontmatter, Handlebars helpers, and TOML configuration schemas.
- API & CLI Reference: Inspect every public struct, trait, error variant, and CLI flag.
- Pipeline Architecture: Understand how the three-stage trait pipeline and
parking_lot::RwLocktemplate cache work under the hood.