{"id":19387471,"url":"https://github.com/alphatechnolog/nerdscanner","last_synced_at":"2025-04-23T23:31:13.468Z","repository":{"id":106237137,"uuid":"366919963","full_name":"AlphaTechnolog/nerdscanner","owner":"AlphaTechnolog","description":"Show a traditional linux tree command, but with the nerdfonts (folder icons, files icons, colors, etc)","archived":false,"fork":false,"pushed_at":"2021-08-31T13:30:17.000Z","size":431,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T21:51:25.149Z","etag":null,"topics":["colors","icons","linux","nerdfonts","python3","tree"],"latest_commit_sha":null,"homepage":"https://alphatechnolog.github.io/nerdscanner/","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/AlphaTechnolog.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}},"created_at":"2021-05-13T03:11:52.000Z","updated_at":"2024-07-08T03:42:55.000Z","dependencies_parsed_at":"2023-05-30T21:00:42.887Z","dependency_job_id":null,"html_url":"https://github.com/AlphaTechnolog/nerdscanner","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlphaTechnolog%2Fnerdscanner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlphaTechnolog%2Fnerdscanner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlphaTechnolog%2Fnerdscanner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlphaTechnolog%2Fnerdscanner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlphaTechnolog","download_url":"https://codeload.github.com/AlphaTechnolog/nerdscanner/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250531935,"owners_count":21446084,"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":["colors","icons","linux","nerdfonts","python3","tree"],"created_at":"2024-11-10T10:09:19.611Z","updated_at":"2025-04-23T23:31:13.218Z","avatar_url":"https://github.com/AlphaTechnolog.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nerdscanner\n\nInspired in the traditional tree command for linux. Show a recursive\nfolder tree with the nerdfonts icons, icons for folders, icons, and\nuse colors for the output.\n\n## Requirements\n\nThe requirements list are:\n\n- A very pretty linux distribution\n- A nerd font used in your terminal\n- A very good and pretty configured terminal\n- Python\n- Git\n- Bash\n\n## Install\n\nTo install use the following commands:\n\n```sh\nmkdir ~/repo\ncd ~/repo\ngit clone https://github.com/AlphaTechnolog/nerdscanner.git\ncd nerdscanner\n./install.sh # Please write your password to create folders in /opt and files in /usr/bin\n```\n\n## Uninstall\n\nTo uninstall use the `uninstall.sh` script:\n\n```sh\ncd $NERDSCANNERPATH\n./uninstall.sh\n```\n\n## Getting started\n\nFirst create a testdir\n\n```sh\ncd $HOME\nmkdir -p testdir/dir1 testdir/dir2 testdir/dir3\ntouch testdir/hello1 testdir/hello2\nln -s $HOME/testdir/dir2 testdir/dir1/dir2\nln -s $HOME/testdir/hello1 testdir/dir2\n```\n\nThe output with tree is:\n\n```\n/home/gabriel/testdir\n├── dir1\n│   └── dir2 -\u003e /home/gabriel/testdir/dir2\n├── dir2\n│   └── hello1 -\u003e /home/gabriel/testdir/hello1\n├── dir3\n├── hello1\n└── hello2\n```\n\nThe output with nerdscanner:\n\n```sh\nnerdscanner $HOME/testdir\n```\n```\n dir1\n   dir2\n     hello1\n hello2\n hello1\n dir3\n dir2\n   hello1\n```\n\nthe folder color is blue and the file color is green.\n\n## Options\n\nTo custom the output pass the next options:\n\n- `-i/--indent-size`: The indent size\n- `-I/--ignore`: Ignore a dirname of filename\n- `-nr/--no-recursive`: Show's a list of dir content with no recursive method (like ls)\n- `-H/--hidden`: Show the hidden files of dir content\n- `-NRD/--no-recursive-dir-icon`: The no recursive tree, directory icon\n- `-p/--path`: No show the name of dirent, show the path of the dirent.\n- `-h/--help`: Show an automatic help log.\n- `-F/--file-icon`: The file icon or prefix\n- `-D/--dir-icon`: The directory icon or prefix\n- `-dc`/`--dir-color`: The directory icon color\n- `-fc`/`--file-color`: The file icon color\n\nFor more information use: `nerdscanner --help`\n\n### Examples\n\n```sh\nnerdscanner $HOME/testdir -i 4 -D \"DIR\" -F \"FILE\"\n```\n\n```\nDIR dir1\n    DIR dir2\n        FILE hello1\nFILE hello2\nFILE hello1\nDIR dir3\nDIR dir2\n    FILE hello1\n```\n\n```sh\nnerdscanner $HOME/testdir -i 2 -dc magenta -fc red\n```\n\n```\n dir1\n   dir2\n     hello1\n hello2\n hello1\n dir3\n dir2\n   hello1\n```\n\nWith the colors changed\n\n```sh\nnerdscanner $HOME/testdir -nr\n```\n\n```\n dir1\n hello2\n hello1\n dir3\n dir2\n```\n\n```sh\nmkdir $HOME/other\ncd $HOME/other\ngit init # this create a folder named .git\nnpm init -y\nnpm install express morgan body-parser # this create a node_modules folder (like to ignore)\ntouch .env\necho 'node_modules' \u003e\u003e .env\necho '.env' \u003e\u003e .env\nmkdir src\necho 'const express = require(\"express\"); const app = express(); app.listen(8000, () =\u003e console.log(\"Listening on port 8000...\"))' \u003e\u003e src/index.js\ncd\nnerdscanner other -HI node_modules .git\n```\n\n```\n .env\n package.json\n  src\n   index.js\n```\n\n```sh\nnerdscanner other -HI node_modules .git -nr -NRD \"FOLDER (no open)\" -F \"FILE\" -i 4 -dc red -fc blue -p\n```\n\n```\nFILE other/.env\nFILE other/package.json\nFOLDER (no open) other/src\n```\n\n## Screenshots\n\n![nerdscanner-1](./.screenshot/nerdscanner.1.png)\n\nFor more screenshots see [The screenshots gallery](./.screenshot)\n\n## Web\n\nSee this documentation in the web! [Press me](https://alphatechnolog.github.io/nerdscanner/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphatechnolog%2Fnerdscanner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falphatechnolog%2Fnerdscanner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphatechnolog%2Fnerdscanner/lists"}