CLI Reference

Documentation for the procclean script.

procclean --help

Usage: procclean [-h] [-v] {list,ls,groups,g,kill,memory,mem} ...

Process cleanup tool with TUI and CLI interfaces.

Positional Arguments:
  {list,ls,groups,g,kill,memory,mem}
                        Commands
    list (ls)           List processes
    groups (g)          Show process groups
    kill                Kill process(es)
    memory (mem)        Show memory summary

Options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit

list / ls

procclean list --help

Usage: procclean list [-h] [-f {table,json,csv,md}]
                      [-s {memory,mem,cpu,pid,name,cwd}] [-a]
                      [-F {killable,orphans,high-memory}] [-k] [-o] [-m]
                      [--high-memory-threshold MB] [--min-memory MB] [-n N]
                      [-c COLS] [--cwd [PATH]]

Options:
  -h, --help            show this help message and exit
  -f, --format {table,json,csv,md}
                        Output format (default: table)
  -s, --sort {memory,mem,cpu,pid,name,cwd}
                        Sort by field (default: memory)
  -a, --ascending       Sort ascending instead of descending
  -F, --filter {killable,orphans,high-memory}
                        Filter preset: killable (orphans, not tmux, not
                        system), orphans, high-memory
  -k, --killable        Shorthand for --filter killable
  -o, --orphans         Shorthand for --filter orphans
  -m, --high-memory     Shorthand for --filter high-memory
  --high-memory-threshold MB
                        Threshold for high memory filter (default: 500 MB)
  --min-memory MB       Minimum memory to include (default: 5 MB)
  -n, --limit N         Limit output to N processes
  -c, --columns COLS    Comma-separated columns
                        (pid,name,rss_mb,cpu_percent,cwd,ppid,parent_name,stat
                        us,cmdline,username)
  --cwd [PATH]          Filter by cwd (no value = current dir, or specify
                        path/glob)

groups / g

procclean groups --help

Usage: procclean groups [-h] [-f {table,json}] [--min-memory MB]

Options:
  -h, --help            show this help message and exit
  -f, --format {table,json}
                        Output format (default: table)
  --min-memory MB       Minimum memory to include (default: 5 MB)

kill

procclean kill --help

Usage: procclean kill [-h] [-f] [-y] [--cwd [PATH]]
                      [-F {killable,orphans,high-memory}] [-k] [-o] [-m]
                      [--min-memory MB] [--high-memory-threshold MB]
                      [--preview] [-O {table,json,csv,md}]
                      [-s {memory,mem,cpu,pid,name,cwd}] [-n N] [-c COLS]
                      [PID ...]

Positional Arguments:
  PID                   Process ID(s) to kill (or use filters)

Options:
  -h, --help            show this help message and exit
  -f, --force           Force kill (SIGKILL instead of SIGTERM)
  -y, --yes             Skip confirmation prompt
  --cwd [PATH]          Kill processes in cwd (no value = current dir, or
                        specify path/glob)
  -F, --filter {killable,orphans,high-memory}
                        Filter preset to select processes
  -k, --killable        Shorthand for --filter killable
  -o, --orphans         Shorthand for --filter orphans
  -m, --high-memory     Shorthand for --filter high-memory
  --min-memory MB       Minimum memory for filter (default: 5 MB)
  --high-memory-threshold MB
                        Threshold for high memory filter (default: 500 MB)
  --preview, --dry-run, --dry
                        Show what would be killed without killing
  -O, --out-format {table,json,csv,md}
                        Output format for preview (default: table)
  -s, --sort {memory,mem,cpu,pid,name,cwd}
                        Sort by field for preview
  -n, --limit N         Limit preview output to N processes
  -c, --columns COLS    Comma-separated columns for preview
                        (pid,name,rss_mb,cpu_percent,cwd,ppid,parent_name,stat
                        us,cmdline,username)

memory / mem

procclean memory --help

Usage: procclean memory [-h] [-f {table,json}]

Options:
  -h, --help            show this help message and exit
  -f, --format {table,json}
                        Output format (default: table)