filesystem-auditor

Description

filesystem-auditor is a pair of high-performance Python scripts designed to scan and analyze repository structures and tech stacks. It handles massive filesystems efficiently using os.scandir and provides detailed Markdown-formatted audits of file types, counts, and sizes. Look at example_output\ forlder for examples.

System Overview

graph TD
    A[Repository Path] --> B{Action}
    B -->|Structure Scan| C[scan_structure.py]
    B -->|Techstack Scan| D[scan_techstack.py]
    C --> E[STRUCTURE.md]
    D --> F[TECHSTACK.md]
    E --> G[Visual Documentation]
    F --> G

Project Structure

filesystem-auditor (local)/
├── scan_structure.py
└── scan_techstack.py

Usage

To audit your repository, run the scripts from the command line:

# Scan directory structure
python scan_structure.py . --output STRUCTURE.md

# Audit techstack (file types, counts, sizes)
python scan_techstack.py . --output TECHSTACK.md

Sample Output

BibTeX Citation

@misc{albeos2026filesystemauditor,
  author = {Rembrant Oyangoren Albeos},
  title = {filesystem-auditor: High-performance repository structure and techstack scanner},
  year = {2026},
  publisher = {Hugging Face},
  journal = {Hugging Face Repository},
  howpublished = {\url{https://huggingface.co/algorembrant/filesystem-auditor/}}
}

Author

Rembrant Oyangoren Albeos (2026)