Shadowtree Manual
Shadowtree is a project-local development task runner. Commands are declared as
recipes in .shadowtree.toml, resolved into inspectable plans, and run in a
sandbox by default so ordinary checks and builds do not mutate the host
checkout.
Start Here
- Getting Started - install Shadowtree, create a config, run recipes, and inspect plans.
- Sandboxing and Sync-Out - understand isolated execution, direct checkout edits, and copying generated files back.
- CLI Inspection - inspect help, recipe listings, printed plans, expanded plans, and dry checks.
- Configuration Files - understand config discovery and the top-level TOML shape.
- Recipe Fields - see the recipe fields that define a workflow.
- Typed Arguments - define positional and named recipe inputs with validation and completion.
- Profile Selection - choose Go or Node built-ins explicitly or through marker detection.
- Editor Support - JSON Schema, Zed, VS Code, and
shadowtree-lsp. - Development - recipes used by the Shadowtree repository itself.
Feature Areas
- Configuration: includes, variables and environment, shell commands, placeholders, recipe references, and recipe resolution.
- Recipes: lifecycle, fan-out and workdirs, logging, tool requirements, and reserved names.
- Arguments: typed arguments, value providers, variadic args, and presets.
- Profiles: Go and Node.
- Integrations: shell completion and editor support.