crab-clean 0.1.1

A CLI tool to tidy your file system by finding and managing duplicate and unused files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use clap::{Parser, Subcommand};
use std::path::PathBuf;

#[derive(Parser, Debug)]
#[command(
    name = "crabclean",
    version = "0.1.0",
    about = "Clean up your file system",
    long_about = "
Clean up your file system by finding and managing duplicate and unused files.

USAGE:
    crabclean <COMMAND> [OPTIONS] [PATH]

COMMANDS:
    duplicate    Find and manage duplicate files
    unused       Find and manage unused files
    help         Print this message or the help of the given subcommand(s)

FLAGS:
    --dry-run, -n   Preview what would be deleted without actually deleting files.
                    If omitted, you will be interactively prompted for each deletion.
                    (Press Ctrl+C to exit at any prompt.)

OPTIONS:
    -a, --age <AGE>   (for 'unused' command) Age in days for a file to be considered unused (default: 30)
    -h, --help        Print help information
    -V, --version     Print version information

EXAMPLES:
    crabclean duplicate --dry-run
    crabclean duplicate /path/to/dir --dry-run
    crabclean duplicate ~/Downloads
    crabclean unused ~/Documents --age 60 --dry-run
    crabclean unused --age 90

NOTES:
    - If you omit the --dry-run flag, the tool will prompt you for each file before deletion.
    - Use Ctrl+C at any prompt to safely exit without deleting files.
    - For feature requests (like grouping files) or issues, please contact: your.email@example.com
"
)]
#[command(propagate_version = true)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Commands,
}

#[derive(Subcommand, Debug)]
pub enum Commands {
    #[command(
        about = "Find and manage duplicate files",
        long_about = "Finds duplicate files in the specified directory using SHA-256 content hashing. Supports dry run and interactive deletion."
    )]
    Duplicate {
        #[arg(default_value = ".")]
        path: PathBuf,
        #[arg(short = 'n', long)]
        dry_run: bool,
    },
    #[command(
        about = "Find and manage unused files",
        long_about = "Finds files that have not been accessed for a specified number of days. Supports dry run and interactive deletion."
    )]
    Unused {
        #[arg(default_value = ".")]
        path: PathBuf,
        #[arg(short, long, default_value_t = 30)]
        age: u32,
        #[arg(short = 'n', long)]
        dry_run: bool,
    },
    Group {
        #[arg(default_value = ".")]
        path: PathBuf,
        #[arg(short = 'g', long, default_value = "all")]
        group_by: String,
        #[arg(short = 'n', long)]
        dry_run: bool,
    },
}

pub fn parse_arguments() -> Cli {
    Cli::parse()
}