treex-cli 0.1.11__tar.gz → 0.1.12__tar.gz

{treex_cli-0.1.11/treex_cli.egg-info → treex_cli-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: treex-cli
-Version: 0.1.11
+Version: 0.1.12
 Summary: List directory contents as a tree with file and directory metadata
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -37,15 +37,19 @@ Dynamic: license-file
 
 ## About
 
-`treex` is a command-line utility that recursively scans a directory and
-lists its contents as a tree along with file and directory metadata.
+`treex` is a command-line utility that recursively scans a directory and lists
+its contents as a tree along with file and directory metadata.
 
+### Features:
+
+- Respects `.gitignore` rules when Git is installed
 - Shows human-readable file sizes
 - Shows recursive directory sizes
 - Shows line counts for text files
 - Identifies binary and unreadable files by type
 - Optionally shows modification timestamps
-- Respects `.gitignore` rules when Git is installed
+- Optionally includes or excludes files using glob patterns
+- Optionally limits the depth of the displayed tree
 
 ----
 
@@ -90,32 +94,80 @@ lists its contents as a tree along with file and directory metadata.
 
 ## Installation
 
-Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
+Install `treex` from [PyPI][pypi-home] using your preferred Python package manager:
 
-- `pip install treex-cli`
-- `pipx install treex-cli`
+- **pip:** `pip install treex-cli`
+- **pipx:** `pipx install treex-cli`
+- **uv:** `uv tool install treex-cli`
 
 ----
 
 ## Usage
 
 ```
-$ treex --help
-usage: treex [-h] [-a] [-m] [-q] [-d] [-s] [directory]
+usage: treex [-h] [--all] [--modified] [--quiet] [--dirs] [--summary]
+             [--include PATTERN] [--exclude PATTERN] [--depth DEPTH]
+             [directory]
 
 List directory contents as a tree with file and directory metadata.
 
 positional arguments:
-  directory       directory to scan (default: current directory)
+  directory              directory to scan (default: current directory)
 
 options:
-  -h, --help      show this help message and exit
-  -a, --all       show all files, including those ignored by Git
-  -m, --modified  show file modification times
-  -q, --quiet     don't show file metadata
-  -d, --dirs      show directories only
-  -s, --summary   show summary only
+  -h, --help             show this help message and exit
+  --all, -a              show all files, including those ignored by Git
+  --modified, -m         show file modification times
+  --quiet, -q            don't show file metadata
+  --dirs, -d             show directories only
+  --summary, -s          show summary only
+  --include, -i PATTERN  include files matching a glob pattern
+  --exclude, -e PATTERN  exclude files matching a glob pattern
+  --depth, -D DEPTH      limit levels displayed below the starting directory
+```
+
+### Filtering files
+
+Use `--include` to display only files that match a glob pattern:
+
 ```
+treex --include '*.py'
+```
+
+Use `--exclude` to hide files that match a glob pattern:
+
+```
+treex --exclude '*.pyc'
+```
+
+Patterns match filenames only, regardless of their location in the directory
+tree. Matching is case-sensitive. When both options are provided, exclusions
+take precedence over inclusions.
+
+For example:
+
+```
+treex --include '.py' --exclude 'test_.py'
+```
+
+This displays Python files except those whose filenames begin with `test_`.
+
+Note: quote glob patterns to prevent the shell from expanding them before
+`treex` receives them.
+
+### Limiting tree depth
+
+Use `--depth` (or `-D`) to limit how many levels below the starting directory
+are displayed:
+
+```
+treex --depth 3
+```
+
+The depth must be at least 1.
+
+Directory sizes and summary totals reflect only files within the limit that pass
+the include/exclude filters.
 
 ----
 
@@ -123,6 +175,7 @@ options:
 
 ![Screenshot](https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/screenshot.png)
 
+
 [github-profile]: https://github.com/cgoldberg
 [github-repo]: https://github.com/cgoldberg/treex
 [pypi-home]: https://pypi.org/project/treex-cli

treex_cli-0.1.12/README.md

@@ -0,0 +1,156 @@
+# treex
+
+## List directory contents as a tree with file and directory metadata
+
+- Copyright (c) 2026 [Corey Goldberg][github-profile]
+- Development: [GitHub][github-repo]
+- Releases: [PyPI][pypi-home]
+- License: [MIT][mit-license]
+
+----
+
+## About
+
+`treex` is a command-line utility that recursively scans a directory and lists
+its contents as a tree along with file and directory metadata.
+
+### Features:
+
+- Respects `.gitignore` rules when Git is installed
+- Shows human-readable file sizes
+- Shows recursive directory sizes
+- Shows line counts for text files
+- Identifies binary and unreadable files by type
+- Optionally shows modification timestamps
+- Optionally includes or excludes files using glob patterns
+- Optionally limits the depth of the displayed tree
+
+----
+
+## Status
+
+<table>
+  <tr>
+    <td>Latest Version</td>
+    <td>
+      <a href="https://pypi.org/project/treex-cli">
+        <img src="https://img.shields.io/pypi/v/treex-cli.svg">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Tests (CI)</td>
+    <td>
+      <a href="https://github.com/cgoldberg/treex/actions/workflows/test.yml">
+        <img src="https://github.com/cgoldberg/treex/actions/workflows/test.yml/badge.svg">
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>Supported Python Versions</td>
+    <td>
+      <a href="https://pypi.org/project/treex-cli">
+        <img src="https://img.shields.io/pypi/pyversions/treex-cli">
+      </a>
+    </td>
+  </tr>
+</table>
+
+----
+
+## Requirements
+
+- Python 3.10+
+- Git 2.0+ (optional)
+- UTF-8-compatible terminal
+
+----
+
+## Installation
+
+Install `treex` from [PyPI][pypi-home] using your preferred Python package manager:
+
+- **pip:** `pip install treex-cli`
+- **pipx:** `pipx install treex-cli`
+- **uv:** `uv tool install treex-cli`
+
+----
+
+## Usage
+
+```
+usage: treex [-h] [--all] [--modified] [--quiet] [--dirs] [--summary]
+             [--include PATTERN] [--exclude PATTERN] [--depth DEPTH]
+             [directory]
+
+List directory contents as a tree with file and directory metadata.
+
+positional arguments:
+  directory              directory to scan (default: current directory)
+
+options:
+  -h, --help             show this help message and exit
+  --all, -a              show all files, including those ignored by Git
+  --modified, -m         show file modification times
+  --quiet, -q            don't show file metadata
+  --dirs, -d             show directories only
+  --summary, -s          show summary only
+  --include, -i PATTERN  include files matching a glob pattern
+  --exclude, -e PATTERN  exclude files matching a glob pattern
+  --depth, -D DEPTH      limit levels displayed below the starting directory
+```
+
+### Filtering files
+
+Use `--include` to display only files that match a glob pattern:
+
+```
+treex --include '*.py'
+```
+
+Use `--exclude` to hide files that match a glob pattern:
+
+```
+treex --exclude '*.pyc'
+```
+
+Patterns match filenames only, regardless of their location in the directory
+tree. Matching is case-sensitive. When both options are provided, exclusions
+take precedence over inclusions.
+
+For example:
+
+```
+treex --include '.py' --exclude 'test_.py'
+```
+
+This displays Python files except those whose filenames begin with `test_`.
+
+Note: quote glob patterns to prevent the shell from expanding them before
+`treex` receives them.
+
+### Limiting tree depth
+
+Use `--depth` (or `-D`) to limit how many levels below the starting directory
+are displayed:
+
+```
+treex --depth 3
+```
+
+The depth must be at least 1.
+
+Directory sizes and summary totals reflect only files within the limit that pass
+the include/exclude filters.
+
+----
+
+## Screenshot
+
+![Screenshot](https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/screenshot.png)
+
+
+[github-profile]: https://github.com/cgoldberg
+[github-repo]: https://github.com/cgoldberg/treex
+[pypi-home]: https://pypi.org/project/treex-cli
+[mit-license]: https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/LICENSE

{treex_cli-0.1.11 → treex_cli-0.1.12}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "treex-cli"
-version = "0.1.11"
+version = "0.1.12"
 description="List directory contents as a tree with file and directory metadata"
 license = "MIT"
 license-files = ["LICENSE"]
@@ -65,7 +65,7 @@ target-version = "py310"
 select = ["ALL"]
 ignore = [
     "ANN", "C901", "COM812", "D", "DTZ001", "DTZ006",
-    "FBT", "PLR", "S603", "S607", "T201"
+    "FBT", "PLR", "S603", "S607", "T201",
 ]
 fixable = ["ALL"]
 

{treex_cli-0.1.11 → treex_cli-0.1.12}/treex.py

@@ -13,6 +13,7 @@ filesystem is scanned normally without Git filtering.
 """
 
 import argparse
+import fnmatch
 import subprocess
 import sys
 from contextlib import suppress
@@ -104,10 +105,10 @@ def _is_binary_file(path, chunk_size=8192):
             chunk = f.read(chunk_size)
         if not chunk:
             return False
-        # Check for NUL bytes.
+        # Check for NUL bytes
         if b"\x00" in chunk:
             return True
-        # Treat files that aren't valid UTF-8 as binary.
+        # Treat files that aren't valid UTF-8 as binary
         try:
             chunk.decode("utf-8")
         except UnicodeDecodeError:
@@ -169,71 +170,181 @@ def _get_tree_entries(path, gitignore):
     return entries
 
 
-def _collect_tree(
+def _matches_pattern(name, pattern):
+    """Match a filename using a case-sensitive glob."""
+    return pattern is not None and fnmatch.fnmatchcase(name, pattern)
+
+
+def _scan_tree(
     path,
-    prefix,
-    stats,
     gitignore,
-    rows,
     show_metadata,
     show_modified,
-    show_files,
+    include_pattern=None,
+    exclude_pattern=None,
+    max_depth=None,
+    depth=0,
 ):
-    """Walk the tree once and collect the output rows."""
+    """Scan and filter the tree, returning nodes for rendering.
+
+    The starting directory has depth 0. Its immediate entries have
+    depth 1. Directories at the depth limit are shown without
+    descending into them. Directory sizes include only files within
+    the permitted depth that pass the include/exclude filters.
+    """
+    if max_depth is not None and depth >= max_depth:
+        return []
     entries = _get_tree_entries(path, gitignore)
     if entries is None:
-        rows.append((prefix + "└── [permission denied]", None))
-        return 0
-    total_size = 0
-    # When files are hidden, only directories determine which visible
-    # entry is last. Files are still processed for stats and sizes.
-    visible_entries = entries
-    if not show_files:
-        visible_entries = [entry for entry in entries if entry.is_dir()]
-    visible_index = 0
+        return [
+            {
+                "name": "[permission denied]",
+                "kind": "error",
+                "children": [],
+                "size": 0,
+                "info": None,
+                "modified": None,
+                "contains_match": False,
+            }
+        ]
+    nodes = []
     for entry in entries:
-        is_visible = show_files or entry.is_dir()
-        if is_visible:
-            is_last = visible_index == len(visible_entries) - 1
-            visible_index += 1
-            connector = "└── " if is_last else "├── "
-            tree_name = prefix + connector + entry.name
-        else:
-            tree_name = None
+        entry_depth = depth + 1
         if entry.is_dir():
+            if max_depth is not None and entry_depth >= max_depth:
+                children = []
+            else:
+                children = _scan_tree(
+                    entry,
+                    gitignore,
+                    show_metadata,
+                    show_modified,
+                    include_pattern,
+                    exclude_pattern,
+                    max_depth,
+                    entry_depth,
+                )
+            contains_match = any(child["contains_match"] for child in children)
+            if include_pattern is not None and not contains_match:
+                continue
+            size = (
+                sum(child["size"] or 0 for child in children) if show_metadata else None
+            )
+            nodes.append(
+                {
+                    "name": entry.name,
+                    "kind": "directory",
+                    "children": children,
+                    "size": size,
+                    "info": None,
+                    "modified": None,
+                    "contains_match": contains_match,
+                }
+            )
+            continue
+        if not entry.is_file():
+            continue
+        # Exclusions take precedence over inclusions
+        if _matches_pattern(entry.name, exclude_pattern):
+            continue
+        if include_pattern is not None and not _matches_pattern(
+            entry.name,
+            include_pattern,
+        ):
+            continue
+        if show_metadata:
+            size_text, info, size, modified = _file_metadata(entry)
+        else:
+            size_text, info, size, modified = None, None, None, None
+        nodes.append(
+            {
+                "name": entry.name,
+                "kind": "file",
+                "children": [],
+                "size": size,
+                "size_text": size_text,
+                "info": info,
+                "modified": modified if show_modified else None,
+                "contains_match": True,
+            }
+        )
+    return nodes
+
+
+def _collect_stats(nodes, stats):
+    """Add node counts and sizes to the summary statistics."""
+    for node in nodes:
+        if node["kind"] == "directory":
             stats["directories"] += 1
-            row_index = len(rows)
+            _collect_stats(node["children"], stats)
+        elif node["kind"] == "file":
+            stats["files"] += 1
+            if stats["total_size"] is not None:
+                stats["total_size"] += node["size"]
+
+
+def _render_tree(nodes, prefix, rows, show_metadata, show_files):
+    """Render nodes as tree rows."""
+    visible = [node for node in nodes if show_files or node["kind"] != "file"]
+    for index, node in enumerate(visible):
+        is_last = index == len(visible) - 1
+        connector = "└── " if is_last else "├── "
+        tree_name = prefix + connector + node["name"]
+        if node["kind"] == "error":
             rows.append((tree_name, None))
-            # Indent nested entries, preserving the tree's vertical branch.
+            continue
+        if node["kind"] == "directory":
+            metadata = (
+                (_format_size(node["size"]), None, None) if show_metadata else None
+            )
+            rows.append((tree_name, metadata))
             extension = "    " if is_last else "│   "
-            dir_size = _collect_tree(
-                entry,
+            _render_tree(
+                node["children"],
                 prefix + extension,
-                stats,
-                gitignore,
                 rows,
                 show_metadata,
-                show_modified,
                 show_files,
             )
-            total_size += dir_size
-            if show_metadata:
-                rows[row_index] = (tree_name, (_format_size(dir_size), None, None))
-        elif entry.is_file():
+        elif show_files:
+            metadata = None
             if show_metadata:
-                size_text, info, size, modified = _file_metadata(entry)
-                stats["files"] += 1
-                stats["total_size"] += size
-                total_size += size
-                if show_files:
-                    timestamp = modified if show_modified else None
-                    rows.append((tree_name, (size_text, info, timestamp)))
-            else:
-                stats["files"] += 1
-                stats["total_size"] = None
-                if show_files:
-                    rows.append((tree_name, None))
-    return total_size
+                metadata = (
+                    node["size_text"],
+                    node["info"],
+                    node["modified"],
+                )
+            rows.append((tree_name, metadata))
+
+
+def _collect_tree(
+    path,
+    prefix,
+    stats,
+    gitignore,
+    rows,
+    show_metadata,
+    show_modified,
+    show_files,
+    include_pattern=None,
+    exclude_pattern=None,
+    max_depth=None,
+):
+    """Collect filtered tree rows and update summary statistics."""
+    if not show_metadata:
+        stats["total_size"] = None
+    nodes = _scan_tree(
+        Path(path),
+        gitignore,
+        show_metadata,
+        show_modified,
+        include_pattern,
+        exclude_pattern,
+        max_depth,
+    )
+    _collect_stats(nodes, stats)
+    _render_tree(nodes, prefix, rows, show_metadata, show_files)
+    return sum(node["size"] or 0 for node in nodes)
 
 
 def print_tree(
@@ -245,12 +356,14 @@ def print_tree(
     show_modified=False,
     show_tree=True,
     show_files=True,
+    include_pattern=None,
+    exclude_pattern=None,
+    max_depth=None,
 ):
     """Print the directory tree with aligned metadata."""
     if stats is None:
         stats = {"directories": 0, "files": 0, "total_size": 0}
     rows = []
-    # Walk the filesystem once and collect the output
     _collect_tree(
         Path(directory),
         prefix,
@@ -260,21 +373,25 @@ def print_tree(
         show_metadata,
         show_modified,
         show_files,
+        include_pattern,
+        exclude_pattern,
+        max_depth,
     )
     if show_tree:
         # Align metadata with the longest tree/name
-        max_tree_name_width = max((len(tree_name) for tree_name, _ in rows), default=0)
+        max_width = max((len(tree_name) for tree_name, _ in rows), default=0)
         for tree_name, metadata in rows:
             if metadata is None:
                 print(tree_name)
                 continue
             size_text, info, modified = metadata
-            output = f"{tree_name:<{max_tree_name_width}}{size_text:>10}"
+            output = f"{tree_name:<{max_width}}{size_text:>10}"
             if info is not None:
                 output += f"    {info:<12}"
             if modified is not None:
                 output += f"    {modified}"
             print(output)
+
     return stats
 
 
@@ -291,11 +408,33 @@ def print_summary(stats):
     print(summary)
 
 
+def _positive_int(value):
+    """Parse a positive integer."""
+    try:
+        number = int(value)
+    except ValueError:
+        msg = "must be a positive integer"
+        raise argparse.ArgumentTypeError(msg) from None
+    if number < 1:
+        msg = "must be at least 1"
+        raise argparse.ArgumentTypeError(msg)
+    return number
+
+
 def parse_args(argv=None):
     """Parse command-line arguments."""
+
+    def formatter(prog):
+        return argparse.HelpFormatter(
+            prog,
+            width=80,
+            max_help_position=30,
+        )
+
     parser = argparse.ArgumentParser(
         description="List directory contents as a tree "
         "with file and directory metadata.",
+        formatter_class=formatter,
     )
     parser.add_argument(
         "directory",
@@ -305,35 +444,54 @@ def parse_args(argv=None):
         help="directory to scan (default: current directory)",
     )
     parser.add_argument(
-        "-a",
         "--all",
+        "-a",
         action="store_true",
         help="show all files, including those ignored by Git",
     )
     parser.add_argument(
-        "-m",
         "--modified",
+        "-m",
         action="store_true",
         help="show file modification times",
     )
     parser.add_argument(
-        "-q",
         "--quiet",
+        "-q",
         action="store_true",
         help="don't show file metadata",
     )
     parser.add_argument(
-        "-d",
         "--dirs",
+        "-d",
         action="store_true",
         help="show directories only",
     )
     parser.add_argument(
-        "-s",
         "--summary",
+        "-s",
         action="store_true",
         help="show summary only",
     )
+    parser.add_argument(
+        "--include",
+        "-i",
+        metavar="PATTERN",
+        help="include files matching a glob pattern",
+    )
+    parser.add_argument(
+        "--exclude",
+        "-e",
+        metavar="PATTERN",
+        help="exclude files matching a glob pattern",
+    )
+    parser.add_argument(
+        "--depth",
+        "-D",
+        type=_positive_int,
+        metavar="DEPTH",
+        help="limit levels displayed below the starting directory",
+    )
     return parser.parse_args(argv)
 
 
@@ -358,6 +516,9 @@ def main():
             show_modified=args.modified,
             show_tree=show_tree,
             show_files=show_files,
+            include_pattern=args.include,
+            exclude_pattern=args.exclude,
+            max_depth=args.depth,
         )
         if show_tree:
             print()

{treex_cli-0.1.11 → treex_cli-0.1.12/treex_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: treex-cli
-Version: 0.1.11
+Version: 0.1.12
 Summary: List directory contents as a tree with file and directory metadata
 Author: Corey Goldberg
 Maintainer: Corey Goldberg
@@ -37,15 +37,19 @@ Dynamic: license-file
 
 ## About
 
-`treex` is a command-line utility that recursively scans a directory and
-lists its contents as a tree along with file and directory metadata.
+`treex` is a command-line utility that recursively scans a directory and lists
+its contents as a tree along with file and directory metadata.
 
+### Features:
+
+- Respects `.gitignore` rules when Git is installed
 - Shows human-readable file sizes
 - Shows recursive directory sizes
 - Shows line counts for text files
 - Identifies binary and unreadable files by type
 - Optionally shows modification timestamps
-- Respects `.gitignore` rules when Git is installed
+- Optionally includes or excludes files using glob patterns
+- Optionally limits the depth of the displayed tree
 
 ----
 
@@ -90,32 +94,80 @@ lists its contents as a tree along with file and directory metadata.
 
 ## Installation
 
-Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
+Install `treex` from [PyPI][pypi-home] using your preferred Python package manager:
 
-- `pip install treex-cli`
-- `pipx install treex-cli`
+- **pip:** `pip install treex-cli`
+- **pipx:** `pipx install treex-cli`
+- **uv:** `uv tool install treex-cli`
 
 ----
 
 ## Usage
 
 ```
-$ treex --help
-usage: treex [-h] [-a] [-m] [-q] [-d] [-s] [directory]
+usage: treex [-h] [--all] [--modified] [--quiet] [--dirs] [--summary]
+             [--include PATTERN] [--exclude PATTERN] [--depth DEPTH]
+             [directory]
 
 List directory contents as a tree with file and directory metadata.
 
 positional arguments:
-  directory       directory to scan (default: current directory)
+  directory              directory to scan (default: current directory)
 
 options:
-  -h, --help      show this help message and exit
-  -a, --all       show all files, including those ignored by Git
-  -m, --modified  show file modification times
-  -q, --quiet     don't show file metadata
-  -d, --dirs      show directories only
-  -s, --summary   show summary only
+  -h, --help             show this help message and exit
+  --all, -a              show all files, including those ignored by Git
+  --modified, -m         show file modification times
+  --quiet, -q            don't show file metadata
+  --dirs, -d             show directories only
+  --summary, -s          show summary only
+  --include, -i PATTERN  include files matching a glob pattern
+  --exclude, -e PATTERN  exclude files matching a glob pattern
+  --depth, -D DEPTH      limit levels displayed below the starting directory
+```
+
+### Filtering files
+
+Use `--include` to display only files that match a glob pattern:
+
 ```
+treex --include '*.py'
+```
+
+Use `--exclude` to hide files that match a glob pattern:
+
+```
+treex --exclude '*.pyc'
+```
+
+Patterns match filenames only, regardless of their location in the directory
+tree. Matching is case-sensitive. When both options are provided, exclusions
+take precedence over inclusions.
+
+For example:
+
+```
+treex --include '.py' --exclude 'test_.py'
+```
+
+This displays Python files except those whose filenames begin with `test_`.
+
+Note: quote glob patterns to prevent the shell from expanding them before
+`treex` receives them.
+
+### Limiting tree depth
+
+Use `--depth` (or `-D`) to limit how many levels below the starting directory
+are displayed:
+
+```
+treex --depth 3
+```
+
+The depth must be at least 1.
+
+Directory sizes and summary totals reflect only files within the limit that pass
+the include/exclude filters.
 
 ----
 
@@ -123,6 +175,7 @@ options:
 
 ![Screenshot](https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/screenshot.png)
 
+
 [github-profile]: https://github.com/cgoldberg
 [github-repo]: https://github.com/cgoldberg/treex
 [pypi-home]: https://pypi.org/project/treex-cli

treex_cli-0.1.11/README.md

@@ -1,103 +0,0 @@
-# treex
-
-## List directory contents as a tree with file and directory metadata
-
-- Copyright (c) 2026 [Corey Goldberg][github-profile]
-- Development: [GitHub][github-repo]
-- Releases: [PyPI][pypi-home]
-- License: [MIT][mit-license]
-
-----
-
-## About
-
-`treex` is a command-line utility that recursively scans a directory and
-lists its contents as a tree along with file and directory metadata.
-
-- Shows human-readable file sizes
-- Shows recursive directory sizes
-- Shows line counts for text files
-- Identifies binary and unreadable files by type
-- Optionally shows modification timestamps
-- Respects `.gitignore` rules when Git is installed
-
-----
-
-## Status
-
-<table>
-  <tr>
-    <td>Latest Version</td>
-    <td>
-      <a href="https://pypi.org/project/treex-cli">
-        <img src="https://img.shields.io/pypi/v/treex-cli.svg">
-      </a>
-    </td>
-  </tr>
-  <tr>
-    <td>Tests (CI)</td>
-    <td>
-      <a href="https://github.com/cgoldberg/treex/actions/workflows/test.yml">
-        <img src="https://github.com/cgoldberg/treex/actions/workflows/test.yml/badge.svg">
-      </a>
-    </td>
-  </tr>
-  <tr>
-    <td>Supported Python Versions</td>
-    <td>
-      <a href="https://pypi.org/project/treex-cli">
-        <img src="https://img.shields.io/pypi/pyversions/treex-cli">
-      </a>
-    </td>
-  </tr>
-</table>
-
-----
-
-## Requirements
-
-- Python 3.10+
-- Git 2.0+ (optional)
-- UTF-8-compatible terminal
-
-----
-
-## Installation
-
-Install `treex` from [PyPI][pypi-home] using either `pip` or `pipx`:
-
-- `pip install treex-cli`
-- `pipx install treex-cli`
-
-----
-
-## Usage
-
-```
-$ treex --help
-usage: treex [-h] [-a] [-m] [-q] [-d] [-s] [directory]
-
-List directory contents as a tree with file and directory metadata.
-
-positional arguments:
-  directory       directory to scan (default: current directory)
-
-options:
-  -h, --help      show this help message and exit
-  -a, --all       show all files, including those ignored by Git
-  -m, --modified  show file modification times
-  -q, --quiet     don't show file metadata
-  -d, --dirs      show directories only
-  -s, --summary   show summary only
-```
-
-----
-
-## Screenshot
-
-![Screenshot](https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/screenshot.png)
-
-[github-profile]: https://github.com/cgoldberg
-[github-repo]: https://github.com/cgoldberg/treex
-[pypi-home]: https://pypi.org/project/treex-cli
-[mit-license]: https://raw.githubusercontent.com/cgoldberg/treex/refs/heads/main/LICENSE