Getting Started

Install

go install github.com/yusing/shadowtree/cmd/shadowtree@latest

Shell Completion

Bash completion:

command -v shadowtree >/dev/null 2>&1 && eval "$(shadowtree completion bash)"

The install recipe appends the same guarded eval line to ~/.bashrc.

Fish completion:

shadowtree completion fish > ~/.config/fish/completions/shadowtree.fish

Zsh completion:

command -v shadowtree >/dev/null 2>&1 && eval "$(shadowtree completion zsh)"

Completion is dynamic: it uses configured recipes plus recipes from the selected profile. Without a config file, Shadowtree detects the nearest Go or Node project marker upward from the current directory and exposes matching built-ins.

Create a Config

Create a default TOML config in a project:

shadowtree init

Shadowtree discovers .shadowtree.toml upward from the current directory. Discovery stops at the git root when the current directory is inside a Git repository.

Run Recipes

In a project with Shadowtree config:

shadowtree config
shadowtree recipes
shadowtree help test
shadowtree help test color=false
shadowtree test
shadowtree build
shadowtree lint

Run one-off commands without adding a recipe:

shadowtree exec -- go test ./...
shadowtree exec -- npm test

Inspect Plans

Inspect the resolved plan before running a recipe:

shadowtree --print test
shadowtree --print --expanded test
shadowtree --check --shell test
shadowtree --verbose build

--verbose prints compact stage boundaries such as == cmd: @build == before commands run. Multiline scripts are shown as <script>, so verbose headers do not dump script bodies.

Built-in Go workflow recipes run once per discovered Go module:

shadowtree --print test

prints the module fan-out:

for_each: @go-modules
workdir: {item}
main: go test ./... {@}