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 export

Export an Oxymakefile to another workflow format.

Usage

ox export <FORMAT> [OPTIONS]

Formats

FormatDescription
snakemakeExport to Snakemake format (Snakefile + config.yaml)

Options

FlagDescription
-f, --file <FILE>Path to the Oxymakefile (default: Oxymakefile.toml)
-o, --output <FILE>Write output to a file instead of stdout

Examples

# Export to stdout
ox export snakemake

# Export to file
ox export snakemake -o Snakefile

# Export a specific Oxymakefile
ox export snakemake -f pipelines/Oxymakefile.toml -o Snakefile

Bidirectional Translation

OxyMake supports bidirectional Snakemake translation:

  • Import: ox translate Snakefile converts Snakemake to OxyMake TOML
  • Export: ox export snakemake converts OxyMake TOML back to Snakemake

This enables zero-friction migration in both directions.

See Also