Files
super-man/README.md
T
leetcrypt 0c6b871713 docs: document all super-man modes in README
Add ask/task/category/explain/ai modes and requirements to the usage
section, matching the script's actual --help output.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-06-08 16:29:11 -07:00

40 lines
1.5 KiB
Markdown

# super-man
An interactive, fuzzy command + man-page flag browser for the terminal. Search
260+ commands, drill into any one to fuzzy-search its flags with live
descriptions, and jump back to the command list instantly.
## Demo
![super-man demo](demo/super-man-demo.gif)
Video (MP4): [`demo/super-man-demo.mp4`](demo/super-man-demo.mp4) ·
asciinema cast: [`demo/super-man-demo.cast`](demo/super-man-demo.cast)
The clip shows opening an entry (`grep`), browsing its flags, then pressing
**Esc** to return straight to the home screen — no intermediary step — and
repeating with `tar`.
## Usage
```bash
super-man # interactive home screen (fzf)
super-man <command> [filter] # jump straight to a command's flags
super-man -l, --list # list all known commands
super-man -h, --help # full help
# Natural-language modes (database-backed, needs jq)
super-man ask "find large files" # ask a question
super-man task "monitor cpu usage" # describe what you want to do
super-man category files # browse by category (files/text/network/system)
super-man explain "tar -czf" # explain what a command does
super-man ai "count lines in js files" # AI-powered NL2SH model (advanced)
```
`Esc` in the flag browser returns to the command list; `Esc` on the home screen
exits.
**Requirements:** `jq` for the natural-language modes, `fzf` for interactive mode.
See [`docs/`](docs/) for design notes and the full feature history.