{"id":14008264,"url":"https://github.com/emad-elsaid/dirtree","last_synced_at":"2025-09-02T10:36:53.066Z","repository":{"id":37773846,"uuid":"95363389","full_name":"emad-elsaid/dirtree","owner":"emad-elsaid","description":"Visualizing files paths as an interactive tree, works nicely with gnu linux tools such as find, ls, or git ls-files","archived":false,"fork":false,"pushed_at":"2020-09-12T18:04:43.000Z","size":281,"stargazers_count":131,"open_issues_count":6,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-09T20:22:16.743Z","etag":null,"topics":["cli","d3js","ruby","visualizer"],"latest_commit_sha":null,"homepage":null,"language":"HTML","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/emad-elsaid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-25T14:03:39.000Z","updated_at":"2025-06-25T18:14:37.000Z","dependencies_parsed_at":"2022-08-08T22:00:52.710Z","dependency_job_id":null,"html_url":"https://github.com/emad-elsaid/dirtree","commit_stats":null,"previous_names":["blazeeboy/dirtree"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/emad-elsaid/dirtree","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emad-elsaid%2Fdirtree","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emad-elsaid%2Fdirtree/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emad-elsaid%2Fdirtree/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emad-elsaid%2Fdirtree/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emad-elsaid","download_url":"https://codeload.github.com/emad-elsaid/dirtree/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emad-elsaid%2Fdirtree/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273271951,"owners_count":25075971,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-02T02:00:09.530Z","response_time":77,"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":["cli","d3js","ruby","visualizer"],"created_at":"2024-08-10T11:01:31.114Z","updated_at":"2025-09-02T10:36:53.035Z","avatar_url":"https://github.com/emad-elsaid.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# Dirtree\n\n[![Gem Version](https://badge.fury.io/rb/dirtree.svg)](https://badge.fury.io/rb/dirtree)\n\nDirtree visualizes an list of file paths into a tree graph, printed as HTML page, it can be useful in visualizing a whole project you're working on to start cleanup or organizing your code or spotting large directories or unneeded files.\n\n## Tree template\n![http://i.imgur.com/cGhx0lG.png](http://i.imgur.com/cGhx0lG.png)\n\n## Flame Graph template\n![https://i.imgur.com/eSTlQNE.png](https://i.imgur.com/eSTlQNE.png)\n\n## Circles template\n![http://i.imgur.com/WvfOgCp.png](http://i.imgur.com/WvfOgCp.png)\n\n## Treemap template\n![https://i.imgur.com/quO67Ky.png](https://i.imgur.com/quO67Ky.png)\n\n## Installation\n\n    $ gem install dirtree\n\n## Usage\n\n    Usage: dirtree [options]... [file]...\n    \n    To get autocompletion functionality\n    run: dirtree completion \u003e\u003e ~/.bashrc\n    Or, dirtree completion \u003e /usr/local/etc/bash_completion.d/dirtree\n        \n        -v, --version                    Print version\n        -h, --help                       Show this help text\n        -l, --local-dependencies         Use saved JavaScript libraries instead of downloading them\n        -s, --screenshot                 Get an image screenshot of the directory tree\n        -o, --output=File.html           Specify a path to write HTML output\n        -t, --template=TemplateName      Specify the template name, available templates [\"tree\", \"circles\", \"flame\", \"treemap\"]\n\n## Examples\n\n**Visualize current directory recursively**\n\n```\n$ dirtree -o output.html **/* *\n```\n\nmake sure you have `globstar` on\n```\n$ shopt -s globstar\n```\n\n**Visualize files from git ls**\n\n```\n$ git ls-files | dirtree -o output.html\n```\n\n**Dirtree prints to standard output if no --output option specified so you can redirect it**\n\n```\n$ git ls-files | dirtree \u003e output.html\n```\n\n**visualize only files that include specific word**\n\n```\n$ git ls-files | grep keyword | dirtree \u003e output.html\n```\n\n**works with find**\n\nvisualize all files that ends with `rb`\n\n```\n$ find ~ -name *rb | dirtree \u003e output.html\n```\n\n**With ag:silver searcher**\n\n```\n$ ag -l | dirtree -o output.html\n```\n\n## Conjunctions\n\n* [lsgh](https://www.github.com/emad-elsaid/lsgh) Draw a tree for a github user/org and open pull requests.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/emad-elsaid/dirtree.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femad-elsaid%2Fdirtree","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femad-elsaid%2Fdirtree","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femad-elsaid%2Fdirtree/lists"}