{"id":19579147,"url":"https://github.com/itsbrex/print-pretty-tree","last_synced_at":"2026-03-10T05:04:12.405Z","repository":{"id":155581507,"uuid":"632193104","full_name":"itsbrex/print-pretty-tree","owner":"itsbrex","description":"Color-coded, pretty printed directory trees.","archived":false,"fork":false,"pushed_at":"2025-05-19T23:34:01.000Z","size":64,"stargazers_count":4,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-06T13:44:58.581Z","etag":null,"topics":["npm-scripts","python3","utils"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itsbrex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-04-24T22:54:37.000Z","updated_at":"2023-12-09T14:20:52.000Z","dependencies_parsed_at":"2023-12-23T17:14:39.155Z","dependency_job_id":"98a18894-b763-4b20-ad2e-71a3f43ef644","html_url":"https://github.com/itsbrex/print-pretty-tree","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/itsbrex/print-pretty-tree","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsbrex%2Fprint-pretty-tree","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsbrex%2Fprint-pretty-tree/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsbrex%2Fprint-pretty-tree/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsbrex%2Fprint-pretty-tree/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itsbrex","download_url":"https://codeload.github.com/itsbrex/print-pretty-tree/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsbrex%2Fprint-pretty-tree/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30325603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T01:36:58.598Z","status":"online","status_checked_at":"2026-03-10T02:00:06.579Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["npm-scripts","python3","utils"],"created_at":"2024-11-11T07:14:46.922Z","updated_at":"2026-03-10T05:04:12.375Z","avatar_url":"https://github.com/itsbrex.png","language":"Python","funding_links":["https://github.com/sponsors/itsbrex"],"categories":[],"sub_categories":[],"readme":"# Print Pretty Tree\n\na.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.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"460\"  src=\"https://i.imgur.com/GSO6vmJ.jpg\"\u003e\n\u003c/p\u003e\n\n## Installation\n\nTo install `print-pretty-tree`, you can use either `pip` or other package managers like `npm`, `pnpm`, or `yarn`.\n\n### Install using pip\n\nIf you have Python and `pip` installed:\n\n```bash\npip install print-pretty-tree --user\n```\n\n### Install using other package managers\n\nIf 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.\n\n```bash\nnpx print-pretty-tree\n```\n\nIf you still want to install `print-pretty-tree` globally, on the command line, run the following command:\n\n```bash\nnpm install -g print-pretty-tree\n```\n\nIf 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).\n\n## Usage\n\nOnce you have installed `print-pretty-tree`, you can run the script in any directory.\n\u003e You can run any of the commands below in any directory, regardless of how you installed it.\n```bash\npt\n\nptree\n\nprint-pretty-tree\n```\n\nThe 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.\n\n## Local Development\n```bash\n# clone the repo\ngit clone https://github.com/itsbrex/print-pretty-tree.git\n\n# cd into the repo\ncd print-pretty-tree\n\n# build the package\npython3 -m build\n```\n\n## Customization\n\n- To add more file types and colors to the output, you can modify the `FILE_TYPE_COLORS` dictionary in the script.\n- You can also customize the excluded file patterns by modifying the `EXCLUDED_PATTERNS` list in the script.\n\n## Contributing\n\nIf 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).\n\n## Contributors ✨\nThanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/github/all-contributors/itsbrex/print-pretty-tree?color=ee8449\u0026style=flat-square)](#Contributing)\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\nThis project follows the [all-contributors](https://allcontributors.org/) specification. Contributions of any kind welcome!\n\n## License\n\nLicensed under the MIT license. See the [LICENSE](./LICENSE) file for more information.\n\nIf you found this project interesting or helpful, please consider [sponsoring me](https://github.com/sponsors/itsbrex) or \u003ca href=\"https://twitter.com/itsbrex\"\u003efollowing me on twitter \u003cimg src=\"https://storage.googleapis.com/saasify-assets/twitter-logo.svg\" alt=\"twitter\" height=\"24px\" align=\"center\"\u003e\u003c/a\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsbrex%2Fprint-pretty-tree","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitsbrex%2Fprint-pretty-tree","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsbrex%2Fprint-pretty-tree/lists"}