Sitemap¶ Home¶ Key Features Quick Install Getting Started Next Steps License Getting Started¶ Installation Requirements Installing from PyPI Installing from Source Verifying the Installation Nerd Font Icons (Optional) Terminal Compatibility Next Steps Quick Start Visualize a Directory Show File Statistics Show Git Status Export a Directory Structure Compare Two Directories Scan a GitHub Repository Common Options Shell Completion Next Steps User Guide¶ Basic Usage Command Structure Getting Help Default Behavior Icon Styles Common Options Excluding Directories Excluding File Extensions Limiting Depth Showing Full Paths Verbose Output Scanning a GitHub Repository File Statistics Grouping by Name Similarity Pattern Filtering Exit Codes Next Steps Visualization Basic Visualization Color Coding Icon Styles File Statistics Lines of Code File Sizes Modification Times Displaying Without Sorting Combining Statistics Grouping by Name Similarity Git Status Directory Depth Control Full Path Display GitHub Repositories Filtering Performance Tips Related Commands Export Basic Usage Available Formats Multiple Formats at Once Output Location and Filename File Statistics Git Status Icon Style Filtering and Depth GitHub Repositories Format Details Text (.txt) JSON (.json) HTML (.html) Markdown (.md) SVG (.svg) reStructuredText (.rst) Examples Compare Basic Comparison Reading the Output File Statistics Saving as HTML Filtering and Depth GitHub Repositories Use Cases HTML Output Terminal Compatibility Pattern Filtering The Four Filtering Mechanisms Directory Exclusion Extension Exclusion Include and Exclude Patterns Ignore Files Order of Precedence Combining Filters Same Behavior Across Commands Examples Shell Completion Recommended: Built-in Installer The completion Command Using Completion Troubleshooting Reference¶ CLI Reference Commands Shared Options Sorting and Display Flags Resolution by command-line order GitHub Repositories Accepted URL forms Authentication Options for a GitHub input visualize Examples export Examples compare Examples config Examples completion version API Reference Module Overview The Structure Dictionary DisplayOptions FileEntry Scanner Tree Rendering Exporters Compare Filtering Flags Sorting Metrics Colors Icons Git Status GitHub Configuration Example: Custom Analysis Script Extending Recursivist Export Formats Available Formats Basic Usage Text (.txt) JSON (.json) HTML (.html) Markdown (.md) reStructuredText (.rst) SVG (.svg) Pattern Matching What Patterns Match Glob Patterns Syntax Examples Usage Regular Expressions Common Syntax Examples Usage Precedence Performance Troubleshooting Examples¶ Basic Examples Visualization File Statistics Git Status Exclusions Exports Comparisons GitHub Repositories Configuration and Version Next Steps Filtering Examples Excluding Directories and Extensions Glob Patterns Regular Expressions Include Patterns Ignore Files Combining Filters Language-Specific Recipes Python JavaScript / TypeScript Java / Maven Filtering with Statistics Filtering in Export and Compare Export Examples Exporting to Each Format Statistics in Exports Output Location and Filename Filtered and Depth-Limited Exports Processing JSON with jq Including a Structure in Documentation Compare Examples Basic Comparisons Comparing GitHub Repositories Comparisons with Statistics Filtered Comparisons Real-World Uses Compare Two Versions Compare Two Git Branches Source vs. Build Backup Verification In Continuous Integration Advanced Examples Codebase Analysis with jq Focusing on Recent or Similar Files Keeping Structure Docs Up to Date Pre-commit Framework Manual Git Hook Continuous Integration Multi-Level Project Map Advanced¶ Integration Git Use Your .gitignore Scan a Repository by URL Pre-commit Framework Manual Git Hook Processing JSON with jq Python Serving Structures from Flask Continuous Integration GitHub Actions GitLab CI Documentation Tools Shell Automation Development Setting Up a Development Environment Prerequisites Clone and Install Install Pre-commit Hooks Project Structure Development Workflow Code Style and Checks Extending Recursivist Add a New Command Add a New Export Format Add a New File Statistic Extend Pattern Matching Customize Colorization Debugging Documentation Release Process Performance Notes Testing Framework Running Tests Markers Test Organization Writing Tests Directory Operations CLI Commands Export Formats File Statistics Parametrization Property-Based Tests Fixtures and Mocking Edge Cases Debugging Failing Tests Continuous Integration Best Practices Contributing¶ Table of Contents Getting Started Setting Up Your Development Environment Development Workflow Creating a Branch Making Changes Testing Your Changes Submitting a Pull Request Coding Standards Code Style Documentation Type Annotations Testing Running Tests Writing Tests Bug Reports and Feature Requests Reporting Bugs Suggesting Features Release Process Community