Recipes¶
Worked examples that combine Recursivist's options, or Recursivist with other tools, to get a specific job done. If you are new to the tool, start with the Quick Start; the User Guide explains each option used here.
| Recipe | What it covers |
|---|---|
| Filtering by Project Type | Ready-made filter sets for Python, JavaScript, and Java projects, and a reusable ignore file |
| Keeping Structure Docs Up to Date | Regenerating an export with pre-commit, a Git hook, GitHub Actions, or GitLab CI |
| Analyzing a Codebase with JSON | Mining a JSON export with jq: totals, largest files, and counts by extension |
| Comparing Versions, Branches, and Builds | Real-world comparisons, including two branches of a GitHub repository and a pull-request check |
| Scripting and Python | Shell loops, exit codes, and using Recursivist as a Python library |