Skip to main content

Flame-graph & treemap disk-usage visualiser

Project description

flamedisk 🔥

Interactive disk-usage visualiser. Scan a directory and open a self-contained HTML report with a flame graph and sortable file tree — no server required.

Tree + Flame view


Install

pip install flamedisk

Requires Python 3.9+. No runtime dependencies beyond the standard library.

Quick start

flamedisk /path/to/scan

The report opens in your default browser. The HTML file is fully self-contained — share it as a single file, no internet connection needed.

CLI

flamedisk [path] [options]
Option Default Description
path . Directory to scan
-o FILE / --output FILE temp file Write HTML to a specific path
--depth N unlimited Maximum scan depth
--min-size BYTES 0 Skip files smaller than this (e.g. 1MB, 512KB)
--exclude NAME … Entry names to skip (e.g. .git node_modules)
--follow-symlinks off Follow symbolic links (cycles are detected and skipped)
--actual-size off Measure allocated disk blocks instead of apparent size, like du (Unix only)
-x / --one-file-system off Skip directories on a different filesystem, like du -x
--dedup-links off Count hard-linked files only once, like du
--workers N auto Thread-pool size. Auto = cpu_count × 4, max 32
-q / --no-browser off Skip opening a browser window
--json off Print raw JSON tree to stdout instead of HTML
--title TEXT Custom HTML page title
--version Print version and exit

Examples

# Scan home directory and open in browser
flamedisk ~

# Save report without opening browser
flamedisk /var/log -o report.html -q

# Limit depth, skip small files
flamedisk /usr --depth 4 --min-size 1MB

# Skip virtual filesystems
flamedisk / --exclude proc sys dev -q

# Path with spaces
flamedisk "/home/My Documents"

# Exclude list followed by a spaced path
flamedisk --exclude .git node_modules -- "/my project"

# Pipe JSON tree to jq
flamedisk . --json | jq '.children[0]'

Python API

from flamedisk import scan, write_html

tree = scan(
    "/home/user",
    max_depth=5,
    exclude=[".git", "node_modules"],
    workers=16,
)
write_html(tree, "report.html")

See docs/api.md for the full API reference.

The report

Tree + Flame view (default)

The left panel shows an expandable file tree. The right panel shows a flame graph — each row is a depth level, each cell is a file or directory sized proportionally to disk usage. The root sits at the bottom; deeper entries grow upward.

Tree + Flame view

Flame view

The flame graph fills the full window.

Flame view

Zoom

Click any directory cell in the flame graph to zoom into it. The original colours and depth levels are preserved — the view rescales so the selected directory fills the full width. Press Esc or click ↺ Reset to return.

Zoom and tooltip

List view

Flat sortable list of the current directory's immediate children. Sort by Name, Size, or Type. The size bar and percentage column always show each entry's share of the total root directory.

List view

Search

Type in the search box (top-right) to highlight matching entries across all views. Matching cells are highlighted; non-matching entries are dimmed.

Unreadable entries

If an entry can't be read during the scan — permission denied, a directory that vanished mid-scan, a stale network handle — flamedisk records it and keeps going rather than aborting. A ⚠ banner in the header shows how many entries were skipped; hover it for the full path and OS error of each. Affected rows in the tree carry a ⚠ marker, and selecting one shows the error in the status bar. Because the contents of a skipped entry are never counted, the totals shown understate actual disk usage by that amount.

Keyboard shortcuts

Key Action
Esc Clear zoom / exit search

Install from source

git clone https://github.com/jrvannucci/flamedisk
cd flamedisk
pip install -e ".[dev]"

Development

pytest              # run the test suite
ruff check .        # lint

Tests run on Linux, macOS, and Windows across Python 3.9–3.13 in CI. Symlink tests skip automatically where the environment cannot create symlinks (Windows without Developer Mode).

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flamedisk-1.1.1.tar.gz (41.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flamedisk-1.1.1-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

Details for the file flamedisk-1.1.1.tar.gz.

File metadata

  • Download URL: flamedisk-1.1.1.tar.gz
  • Upload date:
  • Size: 41.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for flamedisk-1.1.1.tar.gz
Algorithm Hash digest
SHA256 4e820115a197878c59cd4bce0b0602c38f8878bf55a63129f4cb7c8d2a6a6bd3
MD5 5bbeec2ece94f1c24fd94c7bb3926493
BLAKE2b-256 7c9c3cefb5adb204a047605fec4bf9bc0a35b06c3dc3c95d3b78f16a19e43062

See more details on using hashes here.

Provenance

The following attestation bundles were made for flamedisk-1.1.1.tar.gz:

Publisher: publish.yml on jrvannucci/flamedisk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flamedisk-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: flamedisk-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for flamedisk-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b00b1b34032bb29acc24088e26ddc2ffe9d64b528fe93d8b7df373f994187af3
MD5 4f42ab9d4ea8167c5e9ac1ee458ac5bc
BLAKE2b-256 59672631d503f271987fd95c0d36b4ab6a70bbff8a07f71d5b5f3b0b825a4b57

See more details on using hashes here.

Provenance

The following attestation bundles were made for flamedisk-1.1.1-py3-none-any.whl:

Publisher: publish.yml on jrvannucci/flamedisk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page