shellist 0.2.0

Shell history analysis. Parses bash, zsh, and fish history, counts commands, and ranks by frequency.
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

//! Man page (groff/troff) generation.

/// Generate the `shellist` man page as groff source.
pub fn man_page() -> String {
    format!(
        r#".TH SHELLIST 1 "{version}" "shellist {version}" "User Commands"
.SH NAME
shellist \- shell history analysis
.SH SYNOPSIS
.B shellist
[\fIOPTIONS\fR]
.SH DESCRIPTION
Parse shell history files (bash, zsh, fish), count commands, and rank them by
frequency. The default reads ~/.bash_history and prints a ranked table.
.PP
When no path is given and stdin is piped (or \fB-\fR is passed), shellist reads
history from stdin. Use \fB--shell\fR to force a parser; otherwise the format is
auto-detected from the contents.
.SH OPTIONS
.TP
.BR \-\-top = N
Show only the top N commands.
.TP
.BR \-\-ignore = X,Y
Exclude commands (comma-separated).
.TP
.BR \-\-no\-default\-ignore
Do not filter bash internals (set, shopt).
.TP
.BR \-\-min = N
Only show commands used at least N times.
.TP
.BR \-\-path = PATH
Read history from PATH instead of the default file.
.TP
.BR \-\-shell = bash | zsh | fish
Force a specific history parser instead of auto-detecting.
.TP
.BR \-\-depth = N
Treat the first N whitespace tokens as the command key (default 1).
.TP
.BR \-\-json
Output results as a JSON array.
.TP
.BR \-\-csv
Output results as CSV.
.TP
.BR \-\-bars
Add an ASCII bar chart column.
.TP
.BR \-\-percent
Add a percentage column.
.TP
.BR \-\-stats
Print summary statistics instead of the table.
.TP
.BR \-\-grep = PATTERN
Filter command names with a regular expression.
.TP
.BR \-\-asc
Sort results in ascending order.
.TP
.BR \-\-since = YYYY-MM-DD
Only count commands on or after this date (requires timestamps).
.TP
.BR \-\-until = YYYY-MM-DD
Only count commands on or before this date (requires timestamps).
.TP
.BR \-\-trend
Show command counts bucketed over time.
.TP
.BR \-\-trend-bucket = day | week | month
Bucket granularity for --trend (default: day).
.TP
.BR \-\-output = FILE
Write output to FILE instead of stdout.
.TP
.BR \-\-completions = bash | zsh | fish
Print a shell completion script to stdout.
.TP
.BR \-\-man
Print this man page to stdout.
.TP
.BR \-\-help
Print help to stderr.
.SH EXAMPLES
.PP
shellist --top 10
.PP
shellist --shell zsh --path ~/.zsh_history --json
.PP
shellist --depth 2 --bars --percent
.PP
cat ~/.bash_history | shellist --stats
.SH SEE ALSO
.BR bash (1),
.BR zsh (1),
.BR fish (1)
.SH BUGS
Report issues at https://github.com/ultraelectronica/shellist/issues
"#,
        version = env!("CARGO_PKG_VERSION")
    )
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn man_page_has_title_and_options() {
        let m = man_page();
        assert!(m.contains(".TH SHELLIST 1"));
        assert!(m.contains(".SH OPTIONS"));
        assert!(m.contains("\\-\\-json"));
        assert!(m.contains("\\-\\-grep"));
    }
}