{"id":19935943,"url":"https://github.com/gaelgirodon/dirstat","last_synced_at":"2025-05-03T12:31:32.865Z","repository":{"id":56319768,"uuid":"155016163","full_name":"GaelGirodon/dirstat","owner":"GaelGirodon","description":"A simple tool that helps to clean up directories by scanning them and generating interactive statistics reports.","archived":false,"fork":false,"pushed_at":"2025-04-16T20:32:30.000Z","size":578,"stargazers_count":16,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-17T07:42:44.181Z","etag":null,"topics":["clean","cli","directory","folder","green-it","report","scan","statistics"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GaelGirodon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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}},"created_at":"2018-10-27T22:42:40.000Z","updated_at":"2025-04-16T20:32:33.000Z","dependencies_parsed_at":"2023-02-08T20:15:18.843Z","dependency_job_id":"48e94d46-e929-4849-b415-c2476471331c","html_url":"https://github.com/GaelGirodon/dirstat","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GaelGirodon%2Fdirstat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GaelGirodon%2Fdirstat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GaelGirodon%2Fdirstat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GaelGirodon%2Fdirstat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GaelGirodon","download_url":"https://codeload.github.com/GaelGirodon/dirstat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252191035,"owners_count":21709000,"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":["clean","cli","directory","folder","green-it","report","scan","statistics"],"created_at":"2024-11-12T23:22:43.759Z","updated_at":"2025-05-03T12:31:32.317Z","avatar_url":"https://github.com/GaelGirodon.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DirStat\n\n[![release](https://img.shields.io/github/v/release/GaelGirodon/dirstat?style=flat-square)](https://github.com/GaelGirodon/dirstat/releases/latest)\n[![license](https://img.shields.io/github/license/GaelGirodon/dirstat?color=blue\u0026style=flat-square)](./LICENSE)\n[![build](https://img.shields.io/github/actions/workflow/status/GaelGirodon/dirstat/build.yml?branch=main\u0026style=flat-square)](https://github.com/GaelGirodon/dirstat/actions/workflows/build.yml)\n\nA simple tool that helps to clean up directories by scanning them and generating interactive\nstatistics reports.\n\n## About\n\n**DirStat** is a lightweight command-line tool (\u003c 1 MB). It allows to scan a directory that needs to\nbe cleaned up, collect statistics about it and make them easily browsable by generating an\n[interactive graphical HTML report](#report).\n\nStatistics about biggest files and directories (both in size and files count, recursively or not),\nmost used extensions, most frequent modification years and maximum level of nesting help to know\nwhere the disk space has gone and make it easier to clean the directory.\n\n## Install\n\nDownload and extract the [latest release](https://github.com/GaelGirodon/dirstat/releases):\n\n```powershell\n# Windows (PowerShell)\n$DOWNLOAD_URL = \"https://github.com/GaelGirodon/dirstat/releases/latest/download\"\nInvoke-WebRequest -OutFile \"dirstat.zip\" \"$DOWNLOAD_URL/dirstat_windows_amd64.zip\"\nExpand-Archive \"dirstat.zip\" -DestinationPath ./\n```\n\n```shell\n# Linux (Bash)\nDOWNLOAD_URL=\"https://github.com/GaelGirodon/dirstat/releases/latest/download\"\ncurl -sL \"$DOWNLOAD_URL/dirstat_linux_amd64.tar.gz\" | tar xvz\n```\n\n## Usage\n\nOpen a terminal and scan a directory using the `dirstat` binary:\n\n```shell\ndirstat [flags] \u003cpath\u003e\n```\n\nInvoke `dirstat` without any argument to run the interactive mode.\n\n\u003e :warning: Scanning directories with many files can take a long time and leads to a large report.\n\n### Arguments\n\n| Argument    | Description                               | Default |\n| ----------- | ----------------------------------------- | ------- |\n| `\u003cpath\u003e`    | Path to the directory to scan             |         |\n| `-o \u003cpath\u003e` | Path to the directory to write reports to | `.`     |\n| `-v`        | Print the version number and exit         |         |\n| `-h`        | Print the help message and exit           |         |\n\n### Example\n\n#### CLI\n\n```shell\n$ dirstat ./my/dir/ -o ./report/\nScanning ./my/dir/\n42 files scanned\nReports written to report/dirstat-report.*\n```\n\n#### Interactive mode\n\n```shell\n$ dirstat\n   ___  _     ______       __\n  / _ \\(_)___/ __/ /____ _/ /_\n / // / / __/\\ \\/ __/ _ `/ __/\n/____/_/_/ /___/\\__/\\_,_/\\__/\n\nType or paste the path to the directory to scan and press the Enter key:\n\u003e ./my/dir/\n\nScanning ./my/dir/\n42 files scanned\nReports written to dirstat-report.*\n\nPress the Enter key to open the report and exit...\n```\n\n### Report\n\n**DirStat** generates two report files:\n\n- `dirstat-report.html`: the interactive graphical HTML report\n- `dirstat-report.json`: raw directory statistics\n\n![HTML report screenshot](https://user-images.githubusercontent.com/10748287/195948827-cab2cab1-cb27-4b7b-849d-968f910b65f0.png)\n\n## License\n\n**DirStat** is licensed under the GNU General Public License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaelgirodon%2Fdirstat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgaelgirodon%2Fdirstat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgaelgirodon%2Fdirstat/lists"}