Start

Quickstart

Clone Rindle and run the Rust CLI and documentation locally.

Rindle is an early-stage Rust CLI scaffold. It has release and update infrastructure but no application-specific commands yet. No GitHub Release has been published, so the direct installers are not usable until the first release.

Clone and check

Install Rust with rustup and just, then:

git clone https://github.com/amxv/rindle.git
cd rindle
just check
cargo run -- --help

The exact Rust version is pinned in rust-toolchain.toml.

Work on the CLI

The command parser lives in src/cli.rs, with dispatch in src/lib.rs and implementations in src/commands/. Add product commands there and corresponding integration tests under tests/.

Run the docs locally

Install Bun and run:

just docs-install
just docs-dev

The site runs from the isolated docs/ directory, rather than adding JavaScript dependencies to the Rust package.