Skip to main content

9 docs tagged with "reference"

View all tags

CLI flags

Every linux-cleanup command-line flag — modes, options, aliases and defaults — with what each one does and where it is documented in full.

Environment variables

Every environment variable linux-cleanup reads, with its default and effect — output directory overrides, colour control, and XDG config discovery.

Exit codes

What each linux-cleanup exit code means, which ones trigger an automatic crash bundle, and how to branch on them from a script or cron job.

Modes matrix

Every linux-cleanup mode side by side — whether it deletes, whether it is interactive, whether it uses sudo, and whether it writes a session record.

Modes overview

All linux-cleanup modes grouped by what they do — read-only inspection, guided and batch cleanup, interactive personal-data modes, and output and repair helpers.

Output paths

Where linux-cleanup writes its logs, JSON session records, debug bundles and crash bundles — the layout, per-install defaults, retention and permissions.

Protected paths

The complete verified list of paths linux-cleanup refuses to delete — system roots, personal directories, package-manager install roots, and shell-init filenames.

Report schema

The JSON structure a linux-cleanup guided walkthrough writes, with credits, meta, disk, memory, steps and totals.