cleaner-tui 0.1.0

Fastest disk scanner and temporary file cleaner with interactive TUI
Documentation

cleaner-tui

Crates.io Documentation License

Fastest disk scanner and temporary development file cleaner with an interactive Norton/ncdu-style TUI.

Provides both the standalone cleaner CLI/TUI application and an embeddable cleaner_tui library interface for terminal applications (such as Abyss).

Installation

Cargo

cargo install cleaner-tui --locked

CLI Usage

# Launch interactive TUI mode starting in the home directory
cleaner

# Launch interactive TUI mode starting in a specific folder
cleaner ~/Projects

# Run non-interactive CLI dry-run mode (JSON output)
cleaner ~/Projects --json

# Run non-interactive live deletion (permanently removes detected dev artifacts)
cleaner ~/Projects --confirm

Library Usage

To embed the interactive disk analyzer inside your Ratatui application:

use cleaner_tui::{Chrome, CleanOffer, Outcome, Session, StartOpts};
use cleaner_core::config::Config;
use crossterm::event::Event;
use ratatui::prelude::*;
use std::path::PathBuf;
use std::sync::Arc;

fn main() {
    let root = PathBuf::from(".");
    let config = Arc::new(Config::default());
    let mut session = Session::start(root, config, StartOpts::default());

    // In your main event loop:
    session.tick();

    // Render into a ratatui frame:
    // session.draw(frame, area, Chrome::Full);

    // Forward terminal events:
    // if let Outcome::Exit = session.handle_event(event) { ... }
}

License

Dual-licensed under MIT or Apache 2.0.