Print Pretty Tree

a.k.a. ptree is a simple Python script that displays the directory tree of the current working directory with color-coded output for easy file identification.

Installation

To install print-pretty-tree, you can use either pip or other package managers like npm, pnpm, or yarn.

Install using pip

If you have Python and pip installed:

pip install print-pretty-tree --user

Install using other package managers

If you have npm 5.2 or higher, we recommend using npx to run packages globally. This way, you don't need to install the package globally and can still use it as a tool.

npx print-pretty-tree

If you still want to install print-pretty-tree globally, on the command line, run the following command:

npm install -g print-pretty-tree

If you get an EACCES permissions error, you may need to reinstall npm with a version manager or manually change npm's default directory. For more information, see the npm docs here.

Usage

Once you have installed print-pretty-tree, you can run the script in any directory.

You can run any of the commands below in any directory, regardless of how you installed it.

pt

ptree

print-pretty-tree

The script excludes certain files and folders like node_modules and .git by default to make the output easier to manage. It will recursively display the directory structure in a visually pleasing way.

Customization

• To add more file types and colors to the output, you can modify the FILE_TYPE_COLORS dictionary in the script.
• You can also customize the excluded file patterns by modifying the EXCLUDED_PATTERNS list in the script.

Contributing

If you find any bugs or want to suggest new features, please feel free to contribute by submitting an issue or a pull request.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

License

Licensed under the MIT license. See the LICENSE file for more information.

If you found this project interesting or helpful, please consider sponsoring me or following me on twitter