{"id":13620264,"url":"https://github.com/ujjwall-R/Dree","last_synced_at":"2025-04-14T19:31:41.412Z","repository":{"id":177684895,"uuid":"658019912","full_name":"ujjwall-R/Dree","owner":"ujjwall-R","description":"One single package for visualization, debugging, and exploration of folder hierarchies","archived":false,"fork":false,"pushed_at":"2024-10-30T18:49:35.000Z","size":156,"stargazers_count":78,"open_issues_count":24,"forks_count":20,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T01:11:58.743Z","etag":null,"topics":["developer-tools","file-manager-cli","hacktoberfest","hacktoberfest-accepted","hacktoberfest2024"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ujjwall-R.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"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}},"created_at":"2023-06-24T14:14:57.000Z","updated_at":"2025-01-30T06:29:33.000Z","dependencies_parsed_at":"2024-02-08T18:31:27.790Z","dependency_job_id":"0e4a5857-ab22-4172-8cc3-e2e649365c37","html_url":"https://github.com/ujjwall-R/Dree","commit_stats":null,"previous_names":["ujjwall-r/dree"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ujjwall-R%2FDree","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ujjwall-R%2FDree/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ujjwall-R%2FDree/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ujjwall-R%2FDree/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ujjwall-R","download_url":"https://codeload.github.com/ujjwall-R/Dree/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248945924,"owners_count":21187410,"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","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":["developer-tools","file-manager-cli","hacktoberfest","hacktoberfest-accepted","hacktoberfest2024"],"created_at":"2024-08-01T21:00:53.950Z","updated_at":"2025-04-14T19:31:41.405Z","avatar_url":"https://github.com/ujjwall-R.png","language":"C++","funding_links":[],"categories":["C++"],"sub_categories":[],"readme":"# Dree\n\nOne single package for visualization, debugging, and exploration of folder hierarchies.\n\nSay no to bulky file managers with Dree.\n\n## Preview\n\n###### Blog : [Link](https://dev.to/ujjwall-r/i-tried-making-a-terminal-based-file-exploration-package-2142)\n\nDree presents the folders in a tree-like format, with the main folder at the top and its subfolders branching out below it. This makes it easier for you to see how the folders are organized and navigate through them.\n\nOne cool thing about Dree is that you can decide how many levels of folders you want to see at a time. For example, if you only want to see the main folder and its immediate subfolders, you can set the depth to 1. If you want to see more levels of folders, you can increase the depth accordingly. This allows you to focus on the specific parts of the folder structure that are most relevant to you.\n\n![image](https://github.com/ujjwall-R/Dree/assets/75781631/d75b5f2d-55f6-4f66-8c15-6dfbc2822780)\n\nIn addition to displaying the directory structure, Dree offers a powerful search feature within the directory tree. Users can search for specific files or folders within the entire directory structure. Furthermore, Dree allows users to manually adjust their search space by setting the depth level.\n\n![image](https://github.com/ujjwall-R/Dree/assets/75781631/7424fd22-072f-41f7-8d6c-290a93e3bd4b)\n\nThe recommendation feature proves to be particularly helpful when users are unsure about the exact spelling or naming of a file or folder.\n\n![image](https://github.com/ujjwall-R/Dree/assets/75781631/49bc8a09-c626-4cde-8fee-a93b4c06e734)\n\n## Disclaimer\n\n**Important:** This project is undergoing active development, and changes, improvements, and bug fixes are being made frequently.\n\n# Installation\n\nTo run the Directory Tree Visualizer project, follow these steps:\n\n1. Ensure you have C++17 compiler and development environment set up on your linux or mac system\n2. Clone the project repository to your local machine.\n\n```shell\ngit clone https://github.com/ujjwall-R/Dree\ncd Dree\nif [ ! -d \"compile\" ]; then mkdir compile; fi \u0026\u0026 make clean\n```\n\nAdd path to `dree.sh` in `~/.bashrc`. If you use zsh add the path in `~/.zshrc`.\n\n```\n# Add the following line at the end of the ~/.bashrc file\nalias dree='. path/to/project/dree.sh'\n```\n\nRestart terminal or run:\n\n```shell\nsource ~/.bashrc\n```\n\n## Usage\n\n### Print Dree (Directory tree)\n\nRun `dree` followed by number of nested levels you want to visualise:\n\n```shell\ndree 3\n```\n\n### Run Dree TUI File Navigator\n\nUse the flag -n.\n\n```shell\ndree 2 -n\n```\n\n![Nav-Demo](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/xzcmfhyivbgomwx6bm9n.gif)\n\n### Search file or folder in a directory upto certain depth\n\n```shell\n#eg. search a folder in current directory upto 3 depth\ndree 3 -f \"directory_name\"\n#eg. search a file in current directory upto 5 depth\ndree 5 -f \"file_name\"\n```\n\n### Show files currently being ignored\n\nDree includes a `.dreeignore` file that enlists some commonly ignored files and directories. This can be overriden be the use of the `-a` flag.\n\n![image](https://github.com/Ruberald/Dree/assets/31573113/6437731d-c799-4c8e-b939-9e6ef8984d87)\n\n![image](https://github.com/Ruberald/Dree/assets/31573113/3e28ebdd-4311-4801-87aa-a08e2e8014d3)\n\nAs you can see, directories like `node_modules` and files like `.gitignore` are included when the `-a` flag is issued.\n\n# Development\n\n## How to Run [Development]\n\nTo run the Directory Tree Visualizer project, follow these steps:\n\n1. Ensure you have C++17 compiler and development environment set up on your linux or mac system\n2. Clone the project repository to your local machine.\n\n```shell\ncd Dree\n```\n\n### Build\n\n```shell\nif [ ! -d \"compile\" ]; then mkdir compile; fi \u0026\u0026 make clean\n```\n\n### Run\n\n```shell\nmake run\n```\n\n### Compile the changes\n\n```shell\nmake all\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first\nto discuss what you would like to change.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fujjwall-R%2FDree","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fujjwall-R%2FDree","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fujjwall-R%2FDree/lists"}