dirmap – generate annotated directory maps from source files

dirmap is a command-line utility for generating directory maps that explain the purpose of individual directories. Unlike conventional tree viewers, which primarily display filenames and hierarchy, dirmap can attach short descriptions extracted from documentation and source files.

The program is useful for documenting software projects and helping developers understand unfamiliar repositories. It searches designated files in each directory for suitable descriptive text, then incorporates that information into a directory tree or table.

The extraction process is configurable, allowing different documentation conventions and programming languages to be accommodated without rewriting the source files.

This is free and open source software.

Key Features

• Generates directory maps showing filesystem hierarchy alongside descriptive text.
• Extracts directory descriptions from Markdown documents and source code comments.
• Displays results as an annotated directory tree or Markdown table.
• Uses configurable matching rules to select documentation files within each directory.
• Supports searching files in a defined priority order, stopping when suitable descriptive text is found.
• Extracts ordinary Markdown paragraphs for use as directory descriptions.
• Can use the first Markdown heading as a directory overview.
• Supports Go documentation comments as a source of descriptions.
• Allows custom regular expression matchers, including capture groups.
• Supports wildcard filename patterns for finding documentation and source files.
• Excludes selected directories through configurable ignore patterns.
• Can generate an initial configuration file for customizing scanning and extraction rules.
• Supports generating directory documentation without changing the original project files.

Website: github.com/k1LoW/dirmap
Support:
Developer: Ken’ichiro Oyama
License: MIT License

dirmap is written in Go. Learn Go with our recommended free books and free tutorials.

Alternatives to tree

Explore Linux
	Best Free and Open Source Software - A huge collection of recommended free and open source software covering every major category.
	In-depth Linux Software Reviews - Detailed assessments of Linux software covering features, usability and overall quality.
	The Big List of Active Linux Distros - An extensive collection of actively developed Linux distributions.
	Open Source Alternatives - Alternatives to software and services from Google, Microsoft, Apple, Adobe, IBM, Autodesk, Oracle and others.
	Essential Linux System Tools - Indispensable utilities for monitoring, maintaining and managing Linux systems.
	Linux Productivity Tools - Useful utilities for improving productivity and streamlining everyday tasks.
	Alternatives to Popular CLI Tools - Modern alternatives to familiar command-line utilities supplied with Linux systems.
	Awesome Free Linux Game Tools - Tools, utilities and companion software that improve gaming on Linux.
	Machine Learning on Linux - Machine learning and deep learning software, self-hosted applications and practical tools.
	Saving Money with Linux - Practical ways to reduce electricity consumption and lower computing costs with Linux.
	Linux Candy - Fun, entertaining and sometimes delightfully quirky software from the lighter side of Linux.