treels-cli 1.0.1

Enhanced directory tree printer with Git integration

TreeLS

Enhanced directory tree printer with Git integration and ls-like features.

TreeLS combines the functionality of the classic tree command with Git status awareness, providing color-coded file status indicators and powerful filtering options. Perfect for developers who want to quickly visualize project structure and Git state.

✨ Features

• 🌳 Beautiful Tree Display: Rich, colorized directory tree output
• 🔥 Git Integration: Color-coded files based on Git status (PyCharm-style)
• 🎯 Smart Filtering: Show only specific types of files (staged, modified, untracked, etc.)
• 🙈 .gitignore Aware: Automatically respects .gitignore patterns
• ⚡ Fast & Lightweight: Minimal dependencies, maximum performance
• 🛡️ Safe by Default: Hides .git folder and respects ignore patterns

🎨 Git Status Colors

Color	Status	Description
🔴 Red	Untracked	Files not in version control
🟢 Green	Staged	Files staged for commit
🟡 Yellow	Modified	Files modified but not staged
⚫ Dark Grey	Deleted	Files marked for deletion
Default	Committed	Clean, committed files
🔘 Grey	Non-Git	Files in non-Git directories

📦 Installation

pip install treels-cli

Or install from source:

git clone <repository-url>
cd treels
pip install -e .

🚀 Quick Start

# Basic tree view
treels

# Show all files including hidden ones
treels -a

# Show Git status legend
treels --git-status

# Show only modified files
treels --only-modified

Sample Output

Basic tree view:

/home/user/my-project (git)
├── README.md
├── src/
│   ├── main.py
│   ├── utils.py
│   └── config.json
├── tests/
│   ├── test_main.py
│   └── test_utils.py
└── requirements.txt

With Git status colors (when in a Git repository):

/home/user/my-project (git)
├── README.md                    # Default (committed)
├── src/
│   ├── main.py                  # Yellow (modified)
│   ├── utils.py                 # Green (staged)
│   └── config.json              # Default (committed)
├── tests/
│   ├── test_main.py             # Red (untracked)
│   └── test_utils.py            # Default (committed)
├── requirements.txt             # Default (committed)
└── new_feature.py               # Red (untracked)

Filtered view (--only-modified --only-untracked):

/home/user/my-project (git)
├── src/
│   └── main.py                  # Yellow (modified)
├── tests/
│   └── test_main.py             # Red (untracked)
└── new_feature.py               # Red (untracked)

Note: In actual terminal output, the files appear in the colors described in the comments. The examples above show the structure with status indicators for clarity.

📚 Usage Examples

Basic Usage

# Current directory tree
treels

# Specific directory
treels /path/to/project

# Show hidden files (but not .git folder)
treels -a

# Show everything including .git folder
treels -a --show-git

Example: Basic tree in a Python project

/home/user/my-app
├── app.py
├── requirements.txt
├── src/
│   ├── __init__.py
│   ├── models.py
│   └── views.py
├── tests/
│   └── test_app.py
└── docs/
    └── README.md

Example: With hidden files (-a)

/home/user/my-app
├── .env
├── .gitignore
├── app.py
├── requirements.txt
├── src/
│   ├── .cache/
│   ├── __init__.py
│   ├── models.py
│   └── views.py
├── tests/
│   └── test_app.py
└── docs/
    └── README.md

Git-Aware Filtering

# Show only files with changes (any status)
treels --git-uncommitted-only

# Show only committed files (clean)
treels --git-exclude-uncommitted

# Show only staged files (ready for commit)
treels --only-staged

# Show only modified files (need staging)
treels --only-modified

# Show only untracked files (new files)
treels --only-untracked

# Show only deleted files
treels --only-deleted

# Combine filters: show staged OR modified files
treels --only-staged --only-modified

# Show files ready for review (staged + modified)
treels --only-staged --only-modified --git-status

Example: Only modified files (--only-modified)

/home/user/my-app (git)
├── src/
│   ├── models.py                # Yellow (modified)
│   └── views.py                 # Yellow (modified)
└── app.py                       # Yellow (modified)

Example: Only untracked files (--only-untracked)

/home/user/my-app (git)
├── temp_script.py               # Red (untracked)
├── src/
│   └── new_feature.py           # Red (untracked)
└── docs/
    └── draft.md                 # Red (untracked)

Example: Combined filters (--only-staged --only-modified)

/home/user/my-app (git)
├── README.md                    # Green (staged)
├── src/
│   ├── models.py                # Yellow (modified)
│   ├── views.py                 # Yellow (modified)
│   └── config.py                # Green (staged)
└── app.py                       # Yellow (modified)

Example: With Git status legend (--git-status)

/home/user/my-app (git)
├── README.md                    # Green (staged)
├── src/
│   ├── models.py                # Yellow (modified)
│   └── new_feature.py           # Red (untracked)
└── app.py                       # Default (committed)

Git Status: Red=Untracked  Green=Staged  Yellow=Modified  Dark Grey=Deleted  Default=Committed  Grey=Non-Git

Filter Options: --only-staged --only-modified --only-untracked --only-deleted
(Combine multiple filters with OR logic)

Advanced Options

# Limit depth
treels --max-depth 2

# Custom ignore patterns
treels --ignore "node_modules,dist,build"

# Show .gitignore'd files
treels --show-ignored

# Highlight directories in blue
treels --highlight-dirs

# Full status with legend
treels --git-status --only-modified --only-untracked

Example: Max depth limit (--max-depth 2)

/home/user/my-app
├── app.py
├── requirements.txt
├── src/
│   ├── models.py
│   └── views.py
├── tests/
│   └── test_app.py
└── docs/
    └── README.md

Example: Custom ignore (--ignore "tests,docs")

/home/user/my-app
├── app.py
├── requirements.txt
└── src/
    ├── models.py
    └── views.py

Example: Highlight directories (--highlight-dirs)

/home/user/my-app
├── app.py
├── requirements.txt
├── src/                         # Bold blue
│   ├── models.py
│   └── views.py
└── tests/                       # Bold blue
    └── test_app.py

🔧 Command Line Options

Option	Description
path	Root directory (default: current directory)
-a, --all	Show hidden files and directories
--show-ignored	Show files ignored by .gitignore
--show-git	Show .git folder (hidden by default)
--ignore DIRS	Comma-separated list of directories to ignore
--max-depth N	Maximum depth to traverse
--git-status	Show Git status legend
--highlight-dirs	Highlight directories in blue

Git Filtering Options

Option	Description
--git-uncommitted-only	Show only files with any changes
--git-exclude-uncommitted	Show only committed (clean) files
--only-staged	Show only staged files (green)
--only-modified	Show only modified files (yellow)
--only-untracked	Show only untracked files (red)
--only-deleted	Show only deleted files (dark grey)

Note: The --only-* filters can be combined with OR logic. For example, --only-staged --only-modified shows files that are either staged OR modified.

🎯 Common Workflows

Pre-Commit Review

# See what's staged for commit
treels --only-staged

# See what still needs staging
treels --only-modified --only-untracked

# Full pre-commit overview
treels --git-status --only-staged --only-modified --only-untracked

Example: Pre-commit review

$ treels --only-staged
/home/user/my-app (git)
├── README.md                    # Green (staged)
└── src/
    └── config.py                # Green (staged)

$ treels --only-modified --only-untracked
/home/user/my-app (git)
├── src/
│   ├── models.py                # Yellow (modified)
│   └── new_feature.py           # Red (untracked)
└── temp_notes.txt               # Red (untracked)

Code Review

# Show all changed files
treels --git-uncommitted-only

# Focus on specific changes
treels --only-modified --git-status

Example: Code review overview

$ treels --git-uncommitted-only
/home/user/my-app (git)
├── README.md                    # Green (staged)
├── src/
│   ├── models.py                # Yellow (modified)
│   ├── new_feature.py           # Red (untracked)
│   └── config.py                # Green (staged)
└── temp_notes.txt               # Red (untracked)

Project Overview

# Clean project view (hide temp files, show structure)
treels --max-depth 3

# Show everything for debugging
treels -a --show-ignored --show-git

Example: Clean project structure

$ treels --max-depth 3
/home/user/my-app
├── README.md
├── requirements.txt
├── src/
│   ├── __init__.py
│   ├── models/
│   │   ├── user.py
│   │   └── product.py
│   └── views/
│       ├── api.py
│       └── web.py
├── tests/
│   ├── unit/
│   │   ├── test_models.py
│   │   └── test_views.py
│   └── integration/
│       └── test_api.py
└── docs/
    ├── API.md
    └── DEPLOYMENT.md

Working with Large Projects

# Hide build artifacts and dependencies
treels --ignore "node_modules,dist,build,target,.next"

# Focus on source code changes
treels --only-modified --max-depth 2

Example: Large project with filtering

$ treels --ignore "node_modules,dist" --max-depth 2
/home/user/large-project
├── package.json
├── src/
│   ├── components/
│   ├── pages/
│   ├── styles/
│   └── utils/
├── public/
│   ├── images/
│   └── icons/
└── tests/
    ├── unit/
    └── e2e/

🛠️ Development

Install Dependencies

pipenv install --dev

Development Workflow

# Activate virtual environment
pipenv shell

# Run tests
pipenv run test

# Format code
pipenv run format

# Lint code
pipenv run lint

# Build package
pipenv run build

Running Tests

# Run all tests
pytest tests/

# Run with coverage
pytest tests/ --cov=treels

# Run specific test
pytest tests/test_treels.py::TestGitRepository::test_gitignore_parsing

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Add tests for new functionality
5. Run the test suite (pipenv run test)
6. Format your code (pipenv run format)
7. Commit your changes (git commit -m 'Add amazing feature')
8. Push to the branch (git push origin feature/amazing-feature)
9. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Inspired by the classic tree command
• Git status colors based on PyCharm's color scheme
• Built with Rich for beautiful terminal output

🐛 Bug Reports & Feature Requests

Please use the GitHub Issues page to report bugs or request features. When reporting bugs, please include:

• Your operating system and Python version
• The command you ran
• Expected vs actual behavior
• Sample directory structure (if relevant)