https://github.com/itsbrex/print-pretty-tree
Color-coded, pretty printed directory trees.
https://github.com/itsbrex/print-pretty-tree
npm-scripts python3 utils
Last synced: 29 days ago
JSON representation
Color-coded, pretty printed directory trees.
- Host: GitHub
- URL: https://github.com/itsbrex/print-pretty-tree
- Owner: itsbrex
- License: mit
- Created: 2023-04-24T22:54:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T19:30:32.000Z (10 months ago)
- Last Synced: 2025-04-24T20:51:47.875Z (about 1 month ago)
- Topics: npm-scripts, python3, utils
- Language: Python
- Homepage:
- Size: 62.5 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```bash
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.
```bash
npx print-pretty-tree
```
If you still want to install `print-pretty-tree` globally, on the command line, run the following command:
```bash
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](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).
## 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.
```bash
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.
## Local Development
```bash
# clone the repo
git clone https://github.com/itsbrex/print-pretty-tree.git
# cd into the repo
cd print-pretty-tree
# build the package
python3 -m build
```
## 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](https://github.com/itsbrex/print-pretty-tree/issues) or a [pull request](https://github.com/itsbrex/print-pretty-tree/pulls).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
[](#Contributing)
This project follows the [all-contributors](https://allcontributors.org/) specification. Contributions of any kind welcome!
## License
Licensed under the MIT license. See the [LICENSE](./LICENSE) file for more information.
If you found this project interesting or helpful, please consider [sponsoring me](https://github.com/sponsors/itsbrex) or following me on twitter 