treemapper 0.0.8

A tool for mapping directory structures

TreeMapper

TreeMapper is a Python tool designed to convert directory structures and file contents into a YAML format, primarily for use with Large Language Models (LLMs). It helps in codebase analysis, project documentation, and interacting with AI tools by providing a readable representation of your project’s structure.

Key Features

• Converts directory structures into a YAML format
• Captures file contents and includes them in the output
• Supports .gitignore and custom ignore files (.treemapperignore)
• Easy-to-use CLI tool with flexible options for input and output paths
• Works cross-platform (Linux, macOS, and Windows)

Installation

TreeMapper requires Python 3.9 or higher.

You can install TreeMapper using pip:

pip install treemapper

Quick Start

To quickly generate a YAML representation of the current directory and save it to output.yaml, run:

treemapper . -o output.yaml

Usage

TreeMapper can be run from the command line with the following options:

treemapper [directory_path] [-i IGNORE_FILE] [-o OUTPUT_FILE] [--no-git-ignore]

Option	Description
directory_path	The directory to analyze (default: current directory)
-i, --ignore-file	Path to a custom ignore file
-o, --output-file	Path for the output YAML file (default: ./directory_tree.yaml)
--no-git-ignore	Disable git-related default ignores

Example Commands

1. Analyze the current directory, respecting .gitignore and .treemapperignore:

python -m treemapper .

2. Analyze a specific directory with a custom ignore file:

python -m treemapper ./my_project -i custom_ignore.txt

3. Output the YAML representation to a different file:

python -m treemapper ./my_project -o project_structure.yaml

Example Output

name: example_directory
type: directory
children:
  - name: file1.txt
    type: file
    content: |
      This is the content of file1.txt
  - name: subdirectory
    type: directory
    children:
      - name: file2.py
        type: file
        content: |
          def hello_world():
              print("Hello, World!")

Configuration

You can use a .treemapperignore file in your project directory to exclude specific files or directories from the YAML output. The format is similar to .gitignore.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

---