Export codebase structure and contents for AI/LLM context
Project description
TreeMapper
Export your codebase for AI/LLM context in one command.
pip install treemapper
treemapper . -o context.yaml # paste into ChatGPT/Claude
Why TreeMapper?
Unlike tree or find, TreeMapper exports structure + file
contents in a format optimized for LLM context windows:
name: myproject
type: directory
children:
- name: main.py
type: file
content: |
def hello():
print("Hello, World!")
- name: utils/
type: directory
children:
- name: helpers.py
type: file
content: |
def add(a, b):
return a + b
Usage
treemapper . # YAML to stdout + token count
treemapper . -o tree.yaml # save to file
treemapper . -o # save to tree.yaml (default)
treemapper . -o - # explicit stdout output
treemapper . -f json # JSON format
treemapper . -f txt # plain text with indentation
treemapper . -f md # Markdown with fenced code
treemapper . -f yml # YAML (alias)
treemapper . --no-content # structure only
treemapper . --max-depth 3 # limit directory depth
treemapper . --max-file-bytes 10000 # skip files > 10KB
treemapper . --max-file-bytes 0 # no limit
treemapper . -i custom.ignore # custom ignore patterns
treemapper . --no-default-ignores # disable default ignores
treemapper . --log-level info # log level
treemapper . -c # copy to clipboard
treemapper . -c -o tree.yaml # clipboard + save to file
treemapper -v # show version
Diff Context Mode
Smart context selection for git diffs — automatically finds the minimal set of code fragments needed to understand a change:
treemapper . --diff HEAD~1..HEAD # recent changes
treemapper . --diff main..feature # feature branch
treemapper . --diff HEAD~1 --budget 30000 # limit tokens
treemapper . --diff HEAD~1 --full # all changed code
Uses graph-based relevance propagation (Personalized PageRank) to select the most important context within a token budget. Understands imports, type references, config dependencies, and co-change patterns across 13+ programming languages.
Output format:
name: myproject
type: diff_context
fragment_count: 5
fragments:
- path: src/main.py
lines: "10-25"
kind: function
symbol: process_data
content: |
def process_data(items):
...
Options:
| Flag | Default | Description |
|---|---|---|
--budget |
50000 | Maximum output tokens |
--alpha |
0.60 | PPR damping factor |
--tau |
0.08 | Stopping threshold |
--full |
false | Include all changed code |
Token Counting
Token count and size are always displayed on stderr:
12,847 tokens (o200k_base), 52.3 KB
For large outputs (>1MB), approximate counts with ~ prefix:
~125,000 tokens (o200k_base), 5.2 MB
Uses tiktoken with o200k_base encoding (GPT-4o tokenizer).
Clipboard Support
Copy output directly to clipboard with -c or --copy:
treemapper . -c # copy (no stdout)
treemapper . -c -o tree.yaml # copy + save to file
System Requirements:
- macOS:
pbcopy(pre-installed) - Windows:
clip(pre-installed) - Linux (Wayland):
wl-copy - Linux (X11):
xcliporxsel
Python API
from treemapper import map_directory
from treemapper import to_yaml, to_json, to_text, to_markdown
tree = map_directory(
path, # directory path
max_depth=None, # limit traversal depth
no_content=False, # exclude file contents
max_file_bytes=None, # skip large files
ignore_file=None, # custom ignore file
no_default_ignores=False,# disable default ignores
)
yaml_str = to_yaml(tree)
json_str = to_json(tree)
text_str = to_text(tree)
md_str = to_markdown(tree)
Ignore Patterns
Respects .gitignore and .treemapperignore automatically.
Use --no-default-ignores to include everything.
- Hierarchical: nested ignore files at each directory level
- Negation patterns:
!important.logun-ignores a file - Anchored patterns:
/root_only.txtmatches only in root - Output file is always auto-ignored
Content Placeholders
<file too large: N bytes>— exceeds--max-file-bytes<binary file: N bytes>— binary file detected<unreadable content: not utf-8>— not valid UTF-8<unreadable content>— permission denied or I/O error
Development
pip install -e ".[dev]"
pytest
pre-commit run --all-files
License
Apache 2.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file treemapper-1.2.2.tar.gz.
File metadata
- Download URL: treemapper-1.2.2.tar.gz
- Upload date:
- Size: 136.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7bd95da80dc435a0db67b0309ce133e6ba6aaf7159cf5d2aebbca455085bbe90
|
|
| MD5 |
52b385fe445b0aa88a3ccce92e49a383
|
|
| BLAKE2b-256 |
9c239a0de468aeec8445e613f134663d52b1da282bf129e18a359b14fd320e9d
|
Provenance
The following attestation bundles were made for treemapper-1.2.2.tar.gz:
Publisher:
cd.yml on nikolay-e/treemapper
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
treemapper-1.2.2.tar.gz -
Subject digest:
7bd95da80dc435a0db67b0309ce133e6ba6aaf7159cf5d2aebbca455085bbe90 - Sigstore transparency entry: 928659355
- Sigstore integration time:
-
Permalink:
nikolay-e/treemapper@899bf353120614e73ac3b10de36e4fb49ebae6f8 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/nikolay-e
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cd.yml@899bf353120614e73ac3b10de36e4fb49ebae6f8 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file treemapper-1.2.2-py3-none-any.whl.
File metadata
- Download URL: treemapper-1.2.2-py3-none-any.whl
- Upload date:
- Size: 129.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
40d3a1a72c9b130ce74d2adc8b9a4c709a5cdf6b08634465509c60112c5a98fa
|
|
| MD5 |
9893067fda384e56dd60d4785c738843
|
|
| BLAKE2b-256 |
f9d4214c3c407e692d676bb2104ed06b8b15e409f025ab4c444173ffa1f378c4
|
Provenance
The following attestation bundles were made for treemapper-1.2.2-py3-none-any.whl:
Publisher:
cd.yml on nikolay-e/treemapper
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
treemapper-1.2.2-py3-none-any.whl -
Subject digest:
40d3a1a72c9b130ce74d2adc8b9a4c709a5cdf6b08634465509c60112c5a98fa - Sigstore transparency entry: 928659371
- Sigstore integration time:
-
Permalink:
nikolay-e/treemapper@899bf353120614e73ac3b10de36e4fb49ebae6f8 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/nikolay-e
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cd.yml@899bf353120614e73ac3b10de36e4fb49ebae6f8 -
Trigger Event:
workflow_dispatch
-
Statement type: