README.md

---
license: mit
language:
- py
tags:
- filesystem
- auditor
---
# 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.

![license](https://img.shields.io/badge/license-MIT-blue)
![reposize](https://img.shields.io/badge/reposize-29.6%20KB-brightgreen)
![last-commit](https://img.shields.io/badge/last--commit-2026--02--28-orange)
![language-python](https://img.shields.io/badge/language-Python-blue)

## System Overview

```mermaid
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

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

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

```powershell
# 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


<table>
  <tr>
    <td>
      <img src="https://cdn-uploads.huggingface.co/production/uploads/69a2c0056574c22e42cf6624/qb5-yIYhJ8kVeZ1qt4bZN.png" alt="Image 1" width="400">
    </td>
    <td>
      <img src="https://cdn-uploads.huggingface.co/production/uploads/69a2c0056574c22e42cf6624/Ybw9rbkPZ_jQfVfV3Ck3K.png" alt="Image 2" width="400">
    </td>
  </tr>
</table>

## BibTeX Citation
```bibtex
@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)