Recursivist¶
A powerful command-line tool for visualizing directory structures with rich formatting, color-coding, and comprehensive analysis options.
recursivist-demo ~ bash
$ recursivist visualize --sort-by-loc
📂 my-project (1262 lines) ├── 📁 src (1055 lines) │ ├── 📄 main.py (245 lines) │ ├── 📄 utils.py (157 lines) │ └── 📁 tests (653 lines) │ ├── 📄 test_main.py (412 lines) │ └── 📄 test_utils.py (241 lines) ├── 📄 README.md (124 lines) ├── 📄 requirements.txt (18 lines) └── 📄 setup.py (65 lines)
✨ Key Features¶
Colorful Visualization
Each file type is assigned a unique color for easy identification, created deterministically from file extensions for consistent visual mapping.
See visualization File Statistics
Display and sort by lines of code, file sizes, or modification times with formatting appropriate to each metric for better project understanding.
File statistics Smart Filtering
Powerful filtering options combining directory exclusions, extension filtering, glob patterns, regex matching, and gitignore integration for surgical precision.
Filtering options Gitignore Support
Automatically respects your `.gitignore` patterns and similar ignore files to exclude files and directories you don't want to include in the visualization.
Using with Git Pattern Matching
Use glob patterns for simplicity or regular expressions for complex matching needs, with options for both inclusion and exclusion patterns.
Pattern matching Directory Comparison
Compare two directory structures side by side with color-coded highlighting of differences for effective visual differentiation and change analysis.
Compare command Multiple Export Formats
Export to TXT, JSON, HTML, Markdown, and React components with consistent styling across formats for documentation and integration needs.
Export formats Depth Control
Limit directory traversal depth to focus on higher-level structure or specific layers of your project hierarchy for better visualization management.
Depth limiting Shell Completion
Generate and install completion scripts for Bash, Zsh, Fish, and PowerShell to make command entry faster and easier with intelligent suggestions.
Shell completion 🚀 Quick Install¶
Dependencies
Recursivist is built with Rich for beautiful terminal output and Typer for an intuitive command interface.
🏁 Getting Started¶
Installation
Follow our easy installation guide to get up and running in minutes with pip or from source.
Installation guide Quick Start
Jump in with basic commands and examples to visualize, export, and compare directory structures.
Quick start guide Shell Completion
Recursivist supports shell completion for easier command entry. See the shell completion guide for instructions.
📚 Next Steps¶
CLI Reference
Complete reference for all commands, options, and arguments available in Recursivist with detailed explanations.
View CLI Reference Examples
Practical examples showing how to use Recursivist effectively for various scenarios and project types.
Explore Examples Contributing
Guidelines for contributing to the project, including development setup, coding standards, and testing procedures.
Contribution Guide 📜 License¶
This project is licensed under the MIT License.