use crate::{green, yellow};
pub enum HelpTopic {
Root,
Daemon,
Init,
Cd,
Add,
Remove,
Monitored,
Query,
Clean,
Changes,
Health,
}
impl std::fmt::Debug for HelpTopic {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
HelpTopic::Root => write!(f, "Root"),
HelpTopic::Daemon => write!(f, "Daemon"),
HelpTopic::Init => write!(f, "Init"),
HelpTopic::Cd => write!(f, "Cd"),
HelpTopic::Add => write!(f, "Add"),
HelpTopic::Remove => write!(f, "Remove"),
HelpTopic::Monitored => write!(f, "Monitored"),
HelpTopic::Query => write!(f, "Query"),
HelpTopic::Clean => write!(f, "Clean"),
HelpTopic::Changes => write!(f, "Changes"),
HelpTopic::Health => write!(f, "Health"),
}
}
}
pub const fn about(topic: HelpTopic) -> &'static str {
match topic {
HelpTopic::Root => {
concat!(
"Lightweight high-performance file change tracking tool.\n\n",
yellow!("Note:"),
" If installed via 'cargo install', copy to system path for sudo compatibility:\n",
" ",
green!("sudo cp ~/.cargo/bin/fsmon /usr/local/bin/"),
"\n\nConfig: ~/.config/fsmon/fsmon.toml (created by 'fsmon init')",
"\nMonitor: ~/.local/share/fsmon/monitored.jsonl",
"\nLogs: ~/.local/state/fsmon/",
"\nSocket: /run/user/<UID>/fsmon/daemon.sock"
)
}
HelpTopic::Daemon => "Run the fsmon daemon (requires sudo for fanotify)",
HelpTopic::Init => "Create the config file (directories created on first use)",
HelpTopic::Cd => "Open a subshell in the monitored path or log directory",
HelpTopic::Add => "Add a path to the monitoring list",
HelpTopic::Remove => "Remove one or more paths from the monitoring list",
HelpTopic::Monitored => "List all monitored paths with their configuration",
HelpTopic::Query => "Query historical file change events from log files",
HelpTopic::Clean => "Clean historical log files, retain by time or size",
HelpTopic::Changes => "Show the most recent event per path (deduplicated changes)",
HelpTopic::Health => "Query daemon health status",
}
}
pub const fn long_about(topic: HelpTopic) -> &'static str {
match topic {
HelpTopic::Root => {
concat!(
"Lightweight high-performance file change tracking tool.\n\n",
yellow!("Note:"),
" If installed via 'cargo install', copy to system path for sudo compatibility:\n",
" ",
green!("sudo cp ~/.cargo/bin/fsmon /usr/local/bin/"),
"\n\nConfig: ~/.config/fsmon/fsmon.toml (created by 'fsmon init')",
"\nMonitor: ~/.local/share/fsmon/monitored.jsonl",
"\nLogs: ~/.local/state/fsmon/",
"\nSocket: /run/user/<UID>/fsmon/daemon.sock\n\n",
yellow!("Setup (no sudo needed):"),
"\n ",
green!("fsmon init"),
" Create config file\n ",
green!("sudo fsmon init --service"),
" Also install systemd service\n ",
green!("fsmon cd -l"),
" Open subshell in log directory\n ",
green!("fsmon cd -m"),
" Open subshell in monitored store directory\n ",
green!("fsmon cd -c"),
" Open subshell in config directory\n\n",
yellow!("Daemon (requires sudo):"),
"\n ",
green!("sudo fsmon daemon &"),
" Start daemon in background\n ",
green!("sudo systemctl start fsmon"),
" Start via systemd\n ",
green!("journalctl -u fsmon -f"),
" View daemon logs\n ",
green!("kill %1"),
" Stop daemon (or Ctrl+C)\n\n",
yellow!("Management (no sudo needed):"),
"\n ",
green!("fsmon add <cmd> --path /home -r"),
" Track cmd on /home (recursive)\n ",
green!("fsmon add _global --path /home"),
" Monitor /home (all processes)\n ",
green!("fsmon remove <cmd>"),
" Remove cmd group\n ",
green!("fsmon monitored"),
" List monitored paths\n\n",
yellow!("Query (stdout JSONL, pipe to jq):"),
"\n ",
green!("fsmon query <cmd> -t '>1h'"),
" Events from last hour\n ",
green!("fsmon query <cmd> | jq '.'"),
" Pretty print events\n\n",
yellow!("Clean (config defaults: keep_days=30, size>=1GB):"),
"\n ",
green!("fsmon clean <cmd>"),
" Clean cmd log\n ",
green!("fsmon clean <cmd> -t '>7d'"),
" Keep last 7 days"
)
}
HelpTopic::Daemon => {
"Run the fsmon daemon (requires sudo for fanotify)\n\n\
Monitors all configured paths via fanotify and logs events.\n\
Use 'fsmon add'/'fsmon remove' to manage paths dynamically without restarting.\n\n\
Examples:\n\
sudo fsmon daemon & Start daemon in background\n\
sudo fsmon daemon --debug Enable debug output\n\n\
For systemd integration:\n\
sudo fsmon init --service Install systemd service\n\
sudo systemctl start fsmon Start via systemd\n\
journalctl -u fsmon -f View daemon logs\n\n\
Config: ~/.config/fsmon/fsmon.toml\n\
Logs: ~/.local/state/fsmon/"
}
HelpTopic::Init => {
"Create the config file (directories created on first use)\n\n\
Directories are created on first use:\n\
- Monitored dir: by 'fsmon add' on first run\n\
- Log dir: by 'fsmon daemon' or 'fsmon cd -l' on first run\n\n\
With --service, also installs a systemd service:\n\
sudo fsmon init --service"
}
HelpTopic::Cd => {
"Open a subshell in the monitored path or log directory\n\n\
Spawns a new shell (using $SHELL, fallback /bin/sh) in the target directory.\n\
Type 'exit' to return to the original directory.\n\n\
Options:\n\
-m, --monitored cd to the monitored store directory\n\
-l, --logging cd to the log directory\n\
-c, --config cd to the config directory (~/.config/fsmon/)\n\n\
Examples:\n\
fsmon cd -l Open subshell in log directory\n\
fsmon cd -m Open subshell in monitored store directory\n\
fsmon cd -c Open subshell in config directory"
}
HelpTopic::Add => {
"Add a path to the monitoring list\n\n\
The entry is added immediately if the daemon is running, and persisted\n\
in the monitored paths database for automatic monitoring on daemon restart.\n\n\
No sudo needed — store is updated immediately.\n\n\
<CMD> enables process tree tracking: fork/exec children are auto-included.\n\
Use '_global' to monitor all events on a path (no process tracking)."
}
HelpTopic::Remove => {
"Remove one or more paths from the monitoring list\n\n\
Without --path, removes the entire cmd group.\n\
With --path, removes only the specified paths. Multiple paths are atomic:\n\
all must exist, or nothing is removed."
}
HelpTopic::Monitored => {
"List all monitored paths with their configuration\n\n\
Displays each path with its recursive flag, event type filters,\n\
size threshold, path/cmd exclusion patterns."
}
HelpTopic::Query => {
"Query historical file change events from log files\n\n\
Output is JSONL (one JSON object per line), pipe to jq for custom filtering.\n\n\
Native fsmon query uses binary search and is significantly faster on large logs."
}
HelpTopic::Clean => {
"Clean historical log files, retain by time or size\n\n\
Defaults: keep_days=30, size=>=1GB (from fsmon.toml or code fallback).\n\
CLI args override config. Daemon does not auto-clean; use cron/systemd timer."
}
HelpTopic::Changes => {
"Show the most recent event per path (deduplicated changes)\n\n\
Same format as 'query', but with duplicate paths collapsed:\n\
only the latest event for each unique path is shown, sorted by time descending."
}
HelpTopic::Health => {
"Query daemon health status\n\n\
Queries the running daemon's health status via the Unix socket.\n\n\
Returns daemon uptime, memory usage, and monitored path count.\n\
Requires the daemon to be running."
}
}
}