https://github.com/jelmerro/crossdirstat

Free open-source cross-platform file & directory statistics
https://github.com/jelmerro/crossdirstat

directory-statistics electron javascript squarify treeview

Last synced: 5 days ago
JSON representation

Free open-source cross-platform file & directory statistics

• Host: GitHub
• URL: https://github.com/jelmerro/crossdirstat
• Owner: Jelmerro
• License: mit
• Created: 2018-12-13T22:44:58.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T21:56:04.000Z (3 months ago)
• Last Synced: 2025-01-16T14:26:16.218Z (12 days ago)
• Topics: directory-statistics, electron, javascript, squarify, treeview
• Language: JavaScript
• Homepage:
• Size: 899 KB
• Stars: 71
• Watchers: 5
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
crossdirstat

============

![crossdirstat](app/icons/128x128.png)

Free open-source cross-platform file & directory statistics as found on [Github](https://github.com/Jelmerro/crossdirstat)

I have personally replaced crossdirstat with ncdu for the most part,

so major features are not planned, but I will update the Electron version occasionally.

See below for features, installation and why I made crossdirstat all those years ago.

## Features

- Generate a directory tree for any given folder

- View any folder as colored rectangles (squarified algorithm)

- Customize the rectangle colors and show statistics about filetypes

- Export the tree as JSON with sizes and file/folder counters

- Export the rectangle view as JSON, SVG or PNG

- Easy start screen with sane default settings

## Installation

### Easy download

Download a stable installer or executable for your platform from the [github releases page](https://github.com/Jelmerro/crossdirstat/releases).

### Run directly

Clone/download the latest source and run `npm ci` and `npm start`.

### Make your own build

Create your own build with `node build`, see `node build --help` for other options.

## Why another *dirstat application?

There are lots of other similar programs, such as KDirStat, QDirStat and WinDirStat.

A couple of my reasons for creating another one:

- KDirStat and QDirStat don't look pretty on my system

- KDirStat needs tons of KDE dependencies

- QDirStat colors the files per category instead of filetype

- WinDirStat is only available on Windows

- I like to have lots of export options

- Creating my own alternative is a nice project and gives me the chance to make a version which suits my needs

All the alternatives are great programs, but none of them are a perfect fit for me.

## License

crossdirstat was made by [Jelmer van Arnhem](https://github.com/Jelmerro) and is MIT licensed, see LICENSE for details.

This project makes use of the following libraries:

- [Electron](https://github.com/electron/electron) (MIT @ GitHub Inc.)

- [squarify](https://github.com/huy-nguyen/squarify) (MIT @ Huy Nguyen)