Skip to main content

Project file map generator for AI-assisted development

Project description

AITree

Project file map generator for AI-assisted development.

Scans a directory and prints a clean, annotated tree that you can paste directly into any AI chat. Instead of uploading your entire codebase, share the map first — then only send the files the AI actually asks for.

webapp/
├── src/
│   ├── components/
│   │   ├── Header.jsx  [4KB]
│   │   └── Footer.jsx  [2KB]
│   ├── App.jsx  [8KB]
│   └── index.js  [1KB]
├── public/
│   └── index.html  [3KB]
└── package.json  [1KB]

# 2 directories, 6 files  (18KB total)
#
# File types:
#   .jsx          3   ███
#   .js           1   █
#   .html         1   █
#   .json         1   █

Installation

Via pip (recommended):

pip install paracci-aitree

One-liner (Linux / macOS):

curl -fsSL https://raw.githubusercontent.com/paracci/aitree/main/install.sh | bash

One-liner (Windows PowerShell):

irm https://raw.githubusercontent.com/paracci/aitree/main/install.ps1 | iex

From source:

git clone https://github.com/paracci/aitree.git
cd aitree
pip install .

Optional dependencies — install only what you need:

pip install "paracci-aitree[live]"    # --live mode  (watchdog)
pip install "paracci-aitree[tokens]"  # --tokens     (tiktoken)
pip install "paracci-aitree[git]"     # --git-changed (gitpython)
pip install "paracci-aitree[mcp]"     # MCP server   (mcp)
pip install "paracci-aitree[all]"     # everything + clipboard (pyperclip)

Usage

aitree [path] [options]

path defaults to the current directory if omitted.

Output modes

Flag Description
(none) Print tree to stdout
--save Save to _aitree.txt (or _aitree.json / _aitree.md)
--copy Copy output to clipboard
--live Watch for changes and auto-update the saved file
--serve Launch the web UI in your browser

Output formats

Flag Description
--format text Plain text with # comments (default)
--format json Structured JSON with tree + stats + meta
--format markdown Markdown with fenced code block + stats table

Filtering

Flag Description
--depth N Limit tree depth (e.g. --depth 2)
--include GLOB Show only matching files (repeatable)
--exclude GLOB Hide matching files (repeatable)
--no-gitignore Skip .gitignore / .aitreeignore parsing
--git-changed Show only git-changed / untracked files

Extras

Flag Description
--tokens Append estimated token count to output
--version Show version and exit

Examples

aitree .                                    # current directory → stdout
aitree ~/projects/webapp                    # specific path → stdout
aitree . --save                             # save to _aitree.txt
aitree . --copy                             # copy to clipboard
aitree . --depth 2                          # top 2 levels only
aitree . --include "*.py"                   # Python files only
aitree . --include "*.py" --include "*.js"  # multiple patterns
aitree . --exclude "*.test.*"               # hide test files
aitree . --git-changed                      # only modified/untracked files
aitree . --format json --save               # save as _aitree.json
aitree . --format markdown --save           # save as _aitree.md
aitree . --tokens                           # append token count
aitree . --live                             # watch for changes
aitree . --live --depth 2 --git-changed     # live + depth + git filter
aitree . --serve                            # open web UI
aitree . --serve --port 8080                # web UI on a custom port

AI workflow

1. aitree . --copy
2. Paste into your AI chat
3. Ask "Which files do you need?"
4. Send only those files

Web UI

--serve launches a local web server and opens the tree in your browser.

  • Interactive tree with collapse / expand
  • Filter panel: depth, include, exclude, git-changed
  • File content preview on click
  • Live reload when the directory changes
aitree . --serve
aitree . --serve --port 8080

MCP Server

AITree ships a Model Context Protocol server so AI assistants (Claude Desktop, etc.) can call it as a tool.

# Install MCP dependency
pip install "paracci-aitree[mcp]"

# Start the server
aitree-mcp

Available tools

Tool Description
aitree_get_tree Generate a file tree for a local path or GitHub URL
aitree_get_stats Return structured JSON statistics for a path
aitree_get_changed List git-changed / untracked files
aitree_read_file Read the contents of a file inside the project

aitree_read_file lets an AI assistant fetch any file it spotted in the tree — without leaving the conversation:

aitree_get_tree(path=".", format="text")
aitree_read_file(path=".", file="src/auth/login.py")

Claude Desktop config (claude_desktop_config.json)

{
  "mcpServers": {
    "aitree": {
      "command": "aitree-mcp"
    }
  }
}

GitHub URL support

Pass a GitHub repository URL instead of a local path:

aitree https://github.com/owner/repo
aitree https://github.com/owner/repo --depth 2
aitree https://github.com/owner/private-repo --token ghp_xxxx

Works entirely via the GitHub API — no cloning required.


Custom ignore rules

Create .aitreeignore in your project root — same syntax as .gitignore:

# .aitreeignore
*.secret
config/local.json
private/

AITree reads .aitreeignore first, then .gitignore. Use --no-gitignore to skip both.


What gets ignored by default

Category Examples
VCS & editors .git, .idea, .vscode, .svn
Dependencies node_modules, .venv, venv, env
Build output dist, build, target, out, bin
Cache __pycache__, .pytest_cache, .mypy_cache
Binary & temp .pyc, .class, .exe, .log, .tmp
OS files .DS_Store, Thumbs.db

Live mode

--live watches the directory with watchdog and regenerates the output file whenever the structure actually changes. False positives (editor auto-saves, antivirus touches, etc.) are filtered out via content hashing and a 1-second debounce.

🟢  AITree LIVE — Watching: /home/user/projects/webapp  [depth=2, git-changed]
    Updates trigger only on real changes.
    Press Ctrl+C to stop.

[14:32:10] Updated — initial snapshot
[14:33:05] Updated — filesystem change  (3 false events skipped)

Combines with any filter flag: --depth, --include, --exclude, --git-changed.


Platform support

Platform Tested
Linux
macOS
Windows
WSL

Requires Python 3.10+.


License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paracci_aitree-3.2.0.tar.gz (41.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

paracci_aitree-3.2.0-py3-none-any.whl (43.2 kB view details)

Uploaded Python 3

File details

Details for the file paracci_aitree-3.2.0.tar.gz.

File metadata

  • Download URL: paracci_aitree-3.2.0.tar.gz
  • Upload date:
  • Size: 41.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for paracci_aitree-3.2.0.tar.gz
Algorithm Hash digest
SHA256 4f026c09135bfb99f0aaf28b3b97ecd9493425c15751155b8f544819b33ea0a0
MD5 4132989a761c43a27b31269471b56237
BLAKE2b-256 4c02d7bff0c0863d379e0236d5f0b72e73d19ade1f1391a8c8d74b88e677cdc0

See more details on using hashes here.

File details

Details for the file paracci_aitree-3.2.0-py3-none-any.whl.

File metadata

  • Download URL: paracci_aitree-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 43.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for paracci_aitree-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8bf7f227f0bbac0d0ac4b38f8a8f694ec8c6956b4bb34b0242d793e5783559d0
MD5 e8ac15c21ed4580b9fa4b7724d04b67c
BLAKE2b-256 2b598773d342dc31fa85aa15a446de989b16e3c56c94e4359e218ed27deb95c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page