A CLI utility to print the directory tree structure with customizable exclusions.
Project description
PrintDirTree
printdirtree
is a command-line utility that prints the structure of a directory tree,
offering the flexibility to specify files and directories to exclude. This tool
is very useful to aid with prompting ChatGPT.
Installation
Install printdirtree
easily with pip:
pip install printdirtree
Usage
To use dirtree
, simply run the command followed by optional arguments to tailor the output to your needs.
The basic usage prints the current directory structure:
printdirtree
Specifying a Directory
To print the structure of a specific directory:
printdirtree --dir /path/to/directory
Excluding Directories and Files
Exclude specific directories and/or file patterns:
printdirtree --exclude-dir node_modules --exclude-dir .git --exclude-file "*.log"
Saving Preferences
To save your exclusions for future runs:
printdirtree --exclude-dir temp --exclude-file "*.tmp" --save
Viewing Current Exclusions
See what exclusions are currently saved:
printdirtree --view-exclusions
Including Directories and Files Back
To remove exclusions and include directories or files back into the printout:
printdirtree --include-dir temp --include-file "*.tmp" --save
Example Usage
After installing printdirtree
, you can run it to visualize the structure of your project directory. Here's an example command that excludes .git
files:
printdirtree --exclude-file ".git"
Output for the PrintDirTree
project might look like this:
PrintDirTree
├── MANIFEST.in
├── README.md
├── dir_tree_prefs.json
├── printdirtree
│ ├── __init__.py
│ └── __main__.py
└── setup.py
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
Built Distribution
Hashes for printdirtree-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fdaa00c430b3187f43a686689cb679ee393563689eb22b17ee1ae9b65f29a1d |
|
MD5 | b7c95555d759e3abadfa8ca657edc5fc |
|
BLAKE2b-256 | 26817a1d44f4a0364ef22c6af46d294e01ef67a90ca6c510b17f77eb98922417 |