Getting started
Install from source
Build and run Quirl's unreleased 0.1 candidate with the pinned toolchain.
No stable release yet
Quirl is currently built from source. There are no supported package-manager binaries or stable release artifacts to install yet.
Requirements
- Linux or macOS for the supported interactive experience.
- Git.
- Rustup. The repository pins Rust 1.88.0 with
clippyandrustfmt. - Python 3 only for the Unix PTY quality gate.
You do not need a system Lua installation; Quirl embeds vendored Lua 5.4.
Build and run
git clone https://github.com/niklas-heer/quirl.git
cd quirl
cargo run -p quirl-cliFor a guided recording of the major surfaces:
cargo xtask demoVerify a checkout
The canonical local quality gate formats, lints, tests, and validates the workspace's generated artifacts:
cargo xtask checkSee Contributing for focused checks and the complete test strategy.