Woodpecker Documentation

Woodpecker checks, previews, and applies known climate-data fixes through recipes, fix ids, a Python API, and a CLI.

flowchart LR
    D["Dataset"] --> C["check"]
    C --> F["findings"]
    F --> R["recipe or fix id"]
    R --> P["dry-run preview"]
    P --> A["apply"]

Start Here

• Overview: what Woodpecker is for and how the pieces fit.
• Concepts: fixes, recipes, plugins, catalogs, stores, and ids.
• Recipes: run shared workflows by recipe id.
• CLI: list, check, apply, dry-run, and format results.
• Plugins: bundled dataset-family fixes and recipes.

Happy Path

woodpecker list-recipes
woodpecker check ./data --recipe-id cmip6.core_units
woodpecker apply ./data --recipe-id cmip6.core_units --dry-run

Common Tasks

Task	Page
Run a known workflow	Recipes
Choose a fix id directly	Fix Reference
Search recipe metadata	Recipe Reference
Try notebook examples	Examples
Contribute fixes or recipes	Contributing Guide
Work on the docs site	Docs Development

Reference

• Fix Reference
• Recipe Reference
• Interactive Fix Browser