Examples

The examples/ tree in the repo has two subtrees, each serving a different purpose.

recipes/ — pedagogy

Each recipe below lives in examples/recipes/ in the repo. Every one is a complete, runnable Ritefile — clone the repo, cd examples/recipes/<name>, and run rite.

Recipe	What it shows
hello/	The smallest possible Ritefile and the default: dispatcher
variables/	7-tier variable precedence — rite's headline behavior
shell-preprocessor/	${VAR} / ${VAR:-default} / ${VAR:?required}
includes/	Namespaced sub-Ritefiles with scope isolation
dotenv/	Entrypoint vs task-level dotenv: precedence
caching/	sources: + generates: + method: re-run logic
preconditions/	preconditions: (error) vs status: (skip)
prompt/	Destructive-task confirmation, --yes bypass
cross-platform/	platforms: on cmds and tasks
migrate/	Side-by-side Taskfile → Ritefile with annotated warnings

migrated/ — reference corpus

Real-world Taskfiles from go-task/examples mechanically converted with rite --migrate and committed as Ritefiles under examples/migrated/. Distinct from recipes/ in two ways: the files are machine-produced (not hand-written for clarity), and each subdirectory pins the exact upstream SHA it was derived from plus the migrate-tool warnings that fired.

Project	Upstream	Warnings
go-web-app/	go-task/examples@c57278bc/go-web-app	1 × TEMPLATE-KEPT (for )

Purpose is twofold — browse real-shaped Ritefiles in full-project form, and give CI a regression fence. rite examples:verify parses every Ritefile.yml in both subtrees on every run, so a future change to the migrator or parser that breaks a real-world file trips here first.

Upstream attribution lives in examples/NOTICE.

Why runnable examples

Reference docs tell you the shape of a feature. Examples tell you the posture — what a real-world use of the feature tends to look like, which corners tend to come up together, and which warnings you'll hit when you run it through rite --migrate.

Every recipe is intentionally small (one idea per directory). A kitchen-sink example is hard to skim; a focused one you can read in 30 seconds.

Running a recipe

git clone https://github.com/clintmod/rite.git
cd rite/examples/recipes/variables
rite --list
rite

Contributing a recipe

Small and focused beats thorough. The pattern: one directory under examples/recipes/, one Ritefile.yml, one README.md that explains what it demonstrates and the exact commands to run. Open a PR.