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

ox test

Test and validate a workflow without executing it.

The ox test command resolves the DAG, checks for structural errors, and optionally simulates execution order — all without running any shell commands. Use it to catch misconfigurations before committing to a full run.

Usage

ox test                             # Validate entire workflow
ox test results/report.html         # Validate a specific target
ox test --dry-run                   # Simulate execution order
ox test --json                      # Output NDJSON diagnostics

Arguments

ArgumentDescription
[TARGETS]...Target files or patterns to test (default: all)

Options

FlagDescription
-f, --file <FILE>Oxymakefile path (default: Oxymakefile.toml)
-n, --dry-runSimulate execution order without running
--jsonOutput NDJSON

What It Checks

  • Oxymakefile parses without errors
  • All wildcards resolve against [config] values
  • Dependency graph is acyclic
  • Every input is either a source file or produced by a rule
  • Wildcard constraints are satisfied

Examples

# Quick validation in CI
ox test || exit 1

# Check a single target's dependency chain
ox test results/{sample}_stats.tsv

# Dry-run to see execution order
ox test --dry-run

See Also

  • ox lint — lighter-weight syntax check
  • ox plan — show full execution plan