Quirl documentation
Learn the shell, typed data runtime, Lua SDK, plugin platform, and the engineering decisions behind Quirl.
Quirl is a Rust shell that keeps your Bash and Zsh muscle memory working
natively, adds an explicit typed data mode for structured pipelines, and
standardizes configuration, scripts, prompts, completions, and trusted plugins
on one sandboxed Lua 5.5.1 SDK. Quirl 0.5.1 includes this runtime; historical
v0.1.0 artifacts retain their recorded Lua 5.4 runtime.
The native binary remains usable offline. Compatible completion knowledge is delivered separately through an exact-version website channel, so its immutable database generations can improve without manufacturing an otherwise empty binary release.
Recorded with the published macOS ARM release package for v0.5.1 from commit 3f0064c.
The recording provenance identifies the exact
binary and media. Follow the first-session guide
and consult the v0.5.1 release measurements.
0.5 release identity
The current supported release is v0.5.1 for Linux and macOS. A build is official only when an immutable GitHub tag and release name its exact commit; other source checkouts are candidate or development builds. Windows is best-effort portability work. Historical benchmark records apply only to their named artifacts.
Release evidence status — historical. Artifact evidence for measured candidate
23fd5d36907fc816bdafd9aa3c2dcb3afb69feb5and artifact9a893a5f1a0b49d62712f331c88966113d910d94efa9651dc4feffe9fd55b637is historical. Evidence commit14e70939d039d96c195f57452a0e1ec3928194afdocuments that measurement. It is evidence only for that named artifact, not for a later candidate. This historical record does not assert the release-readiness or human-review state of a later candidate.
Start here
Install Quirl
Install v0.5.1 through Homebrew or a verified native archive.
Your first session
Move from familiar commands to typed data and back again.
Understand the language
Read the complete product and language specification.
Extend with Lua
Use one bounded SDK for scripts, configuration, and plugins.
What is documented
These docs distinguish current user workflows and runtime contracts from long-term design, historical research, and exact-artifact release evidence. Authored guides sit beside complete source documents so nothing important is hidden behind a summary.