Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Meta keys

A fenced block with the language meta (TOML) in a task section. Unknown or invalid values are an error.

KeyTypeDescription
dependsarray of stringsTasks to run first
parallelboolRun depends concurrently
ifstringCondition; task skipped when false
retriesintegerExtra attempts after a failure
retry_delaydurationWait between attempts (default 1s)
timeoutdurationPer-attempt limit; exit 124
captureboolExpose stdout as MX_OUTPUT_<TASK> to dependents
sourcesarray of globsInput files for up-to-date checks and --watch
outputsarray of pathsFiles that must exist for the task to be considered up to date
paramsarray of stringsNamed parameters (name required, name=value default)
envarray of KEY=VALUEDefault environment variables
dirstringWorking directory
aliasarray of stringsAlternate names
privateboolHide from listings
importsarray of pathsDocument-wide only: files to import

Environment variables set for tasks: MX_ARGS, MX_ARG_<N>, MX_PARAM_<NAME>, MX_OUTPUT_<TASK>.