docs(readme): sync CLI examples with current flags
- commit
- 00c4c813c275c410f4bf1ccac5e957e8252fce4c
- author
- brice · · 2025-12-26 14:18 UTC
- parent
- 73bf644
- signature
- unsigned
2 files · +34 -26
M CHANGELOG.md +3 -0
| @@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file. | |||
| 4 | 4 | ||
| 5 | 5 | ## [Unreleased] | |
| 6 | 6 | ||
| 7 | + | ### Fixed | |
| 8 | + | - README CLI examples: updated to match current commands/flags (`purge --force` only, `logs` usage, `sessions list --limit`, removed deprecated `--dmenu` root flag). | |
| 9 | + | ||
| 7 | 10 | ## [0.21.0] - 2025-12-26 | |
| 8 | 11 | ||
| 9 | 12 | ### Added | |
| @@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file. | |||||
| 4 | 4 | ||||
| 5 | ## [Unreleased] | 5 | ## [Unreleased] | ||
| 6 | 6 | ||||
| 7 | + | ### Fixed | |||
| 8 | + | - README CLI examples: updated to match current commands/flags (`purge --force` only, `logs` usage, `sessions list --limit`, removed deprecated `--dmenu` root flag). | |||
| 9 | + | ||||
| 7 | ## [0.21.0] - 2025-12-26 | 10 | ## [0.21.0] - 2025-12-26 | ||
| 8 | 11 | ||||
| 9 | ### Added | 12 | ### Added | ||
M README.md +31 -26
| @@ -234,44 +234,49 @@ sudo apt install va-driver-all | |||
| 234 | 234 | - The resulting `./dist/dumber-no-gui` binary runs CLI flows with GUI code stubbed | |
| 235 | 235 | ||
| 236 | 236 | ## Usage | |
| 237 | - | - Open a URL or search: | |
| 237 | + | - Open a URL, local file, or search: | |
| 238 | 238 | - `dumber browse https://example.com` | |
| 239 | - | - `dumber browse example.com` # scheme auto‑added | |
| 240 | - | - `dumber browse dumb://home` # built-in home page (stats, shortcuts, etc.) | |
| 241 | - | - `dumber browse "!g golang"` # Google search via bang shortcut | |
| 239 | + | - `dumber browse example.com` # scheme auto‑added | |
| 240 | + | - `dumber browse ./test.html` # local file path (converted to file://) | |
| 241 | + | - `dumber browse dumb://home` # built-in home page (stats, shortcuts, etc.) | |
| 242 | + | - `dumber browse "!g golang"` # search via bang shortcut | |
| 242 | 243 | - Show version information: | |
| 243 | - | - `dumber about` # display version, commit, and build date | |
| 244 | + | - `dumber about` # version, commit, and build date | |
| 244 | 245 | - Launcher integration (dmenu‑style examples with favicon support): | |
| 245 | 246 | - rofi: `dumber dmenu | rofi -dmenu -show-icons -p "🔍 " | dumber dmenu --select` | |
| 246 | 247 | - fuzzel: `dumber dmenu | fuzzel --dmenu -p "🔍 " | dumber dmenu --select` | |
| 248 | + | - `dumber dmenu --interactive` # built-in TUI fuzzy finder | |
| 249 | + | - `dumber dmenu --max 200` # limit output entries | |
| 247 | 250 | - Manage browsing history: | |
| 248 | - | - `dumber history` # interactive history browser (timeline tabs + fuzzy search) | |
| 249 | - | - `dumber history --json` # output recent entries as JSON | |
| 250 | - | - `dumber history --json --max 50` # limit JSON output to N entries | |
| 251 | - | - `dumber history stats` # show history statistics | |
| 252 | - | - `dumber history clear` # interactive cleanup (select time range) | |
| 253 | - | - Clean up data and cache: | |
| 254 | - | - `dumber purge` # purge all data (with confirmation) | |
| 255 | - | - `dumber purge --force` # purge all data (no confirmation) | |
| 256 | - | - `dumber purge -d -H -c` # purge database and both caches | |
| 257 | - | - `dumber purge --browser-data` # purge WebKit data (cookies, etc.) | |
| 251 | + | - `dumber history` # interactive history browser (timeline tabs + fuzzy search) | |
| 252 | + | - `dumber history --json` # output recent entries as JSON | |
| 253 | + | - `dumber history --json --max 50` # limit JSON output to N entries | |
| 254 | + | - `dumber history stats` # show history statistics | |
| 255 | + | - `dumber history clear` # interactive time-range cleanup | |
| 256 | + | - Clean up data: | |
| 257 | + | - `dumber purge` # interactive selection (TUI) | |
| 258 | + | - `dumber purge --force` # remove everything (no prompts) | |
| 258 | 259 | - Manage sessions: | |
| 259 | - | - `dumber sessions` # interactive session browser (TUI) | |
| 260 | - | - `dumber sessions list` # list saved sessions | |
| 261 | - | - `dumber sessions list --json` # output sessions as JSON | |
| 262 | - | - `dumber sessions restore <id>` # restore a session in new window | |
| 263 | - | - `dumber sessions delete <id>` # delete a saved session | |
| 260 | + | - `dumber sessions` # interactive session browser (TUI) | |
| 261 | + | - `dumber sessions list` # list saved sessions | |
| 262 | + | - `dumber sessions list --json` # output sessions as JSON | |
| 263 | + | - `dumber sessions list --limit 50` # limit number of sessions shown | |
| 264 | + | - `dumber sessions restore <id>` # restore a session in a new window | |
| 265 | + | - `dumber sessions delete <id>` # delete a saved session | |
| 264 | 266 | - Manage logs: | |
| 265 | - | - `dumber logs list` # list available log files | |
| 266 | - | - `dumber logs tail` # tail current log file | |
| 267 | - | - `dumber logs clean` # clean up old log files | |
| 267 | + | - `dumber logs` # list sessions with log files | |
| 268 | + | - `dumber logs <session>` # show logs for a session (full ID or unique suffix) | |
| 269 | + | - `dumber logs -f <session>` # follow logs in real time | |
| 270 | + | - `dumber logs -n 200 <session>` # show last N lines | |
| 271 | + | - `dumber logs clear` # clean up old log files | |
| 272 | + | - `dumber logs clear --all` # remove all log files | |
| 268 | 273 | ||
| 269 | 274 | ### Dmenu mode invocation | |
| 270 | 275 | You can invoke dmenu mode in two ways: | |
| 271 | - | - Subcommand (recommended): `dumber dmenu` … and `dumber dmenu --select` | |
| 272 | - | - Root flag (generate options only): `dumber --dmenu` | |
| 276 | + | - Piped launcher (generate options): `dumber dmenu` | |
| 277 | + | - Receive selection from stdin: `dumber dmenu --select` | |
| 273 | 278 | ||
| 274 | - | Note: The root flag path only generates options; for processing a selection (`--select`), use the `dmenu` subcommand as the receiving command. | |
| 279 | + | For a built-in fuzzy finder UI, use: `dumber dmenu --interactive` | |
| 275 | 280 | ||
| 276 | 281 | In GUI mode the app serves an embedded home page via `dumb://home`, and frontend assets under `dumb://app/...`. | |
| 277 | 282 | ||
| @@ -234,44 +234,49 @@ sudo apt install va-driver-all | |||||
| 234 | - The resulting `./dist/dumber-no-gui` binary runs CLI flows with GUI code stubbed | 234 | - The resulting `./dist/dumber-no-gui` binary runs CLI flows with GUI code stubbed | ||
| 235 | 235 | ||||
| 236 | ## Usage | 236 | ## Usage | ||
| 237 | - | - Open a URL or search: | 237 | + | - Open a URL, local file, or search: |
| 238 | - `dumber browse https://example.com` | 238 | - `dumber browse https://example.com` | ||
| 239 | - | - `dumber browse example.com` # scheme auto‑added | 239 | + | - `dumber browse example.com` # scheme auto‑added |
| 240 | - | - `dumber browse dumb://home` # built-in home page (stats, shortcuts, etc.) | 240 | + | - `dumber browse ./test.html` # local file path (converted to file://) |
| 241 | - | - `dumber browse "!g golang"` # Google search via bang shortcut | 241 | + | - `dumber browse dumb://home` # built-in home page (stats, shortcuts, etc.) |
| 242 | + | - `dumber browse "!g golang"` # search via bang shortcut | |||
| 242 | - Show version information: | 243 | - Show version information: | ||
| 243 | - | - `dumber about` # display version, commit, and build date | 244 | + | - `dumber about` # version, commit, and build date |
| 244 | - Launcher integration (dmenu‑style examples with favicon support): | 245 | - Launcher integration (dmenu‑style examples with favicon support): | ||
| 245 | - rofi: `dumber dmenu | rofi -dmenu -show-icons -p "🔍 " | dumber dmenu --select` | 246 | - rofi: `dumber dmenu | rofi -dmenu -show-icons -p "🔍 " | dumber dmenu --select` | ||
| 246 | - fuzzel: `dumber dmenu | fuzzel --dmenu -p "🔍 " | dumber dmenu --select` | 247 | - fuzzel: `dumber dmenu | fuzzel --dmenu -p "🔍 " | dumber dmenu --select` | ||
| 248 | + | - `dumber dmenu --interactive` # built-in TUI fuzzy finder | |||
| 249 | + | - `dumber dmenu --max 200` # limit output entries | |||
| 247 | - Manage browsing history: | 250 | - Manage browsing history: | ||
| 248 | - | - `dumber history` # interactive history browser (timeline tabs + fuzzy search) | 251 | + | - `dumber history` # interactive history browser (timeline tabs + fuzzy search) |
| 249 | - | - `dumber history --json` # output recent entries as JSON | 252 | + | - `dumber history --json` # output recent entries as JSON |
| 250 | - | - `dumber history --json --max 50` # limit JSON output to N entries | 253 | + | - `dumber history --json --max 50` # limit JSON output to N entries |
| 251 | - | - `dumber history stats` # show history statistics | 254 | + | - `dumber history stats` # show history statistics |
| 252 | - | - `dumber history clear` # interactive cleanup (select time range) | 255 | + | - `dumber history clear` # interactive time-range cleanup |
| 253 | - | - Clean up data and cache: | 256 | + | - Clean up data: |
| 254 | - | - `dumber purge` # purge all data (with confirmation) | 257 | + | - `dumber purge` # interactive selection (TUI) |
| 255 | - | - `dumber purge --force` # purge all data (no confirmation) | 258 | + | - `dumber purge --force` # remove everything (no prompts) |
| 256 | - | - `dumber purge -d -H -c` # purge database and both caches | |||
| 257 | - | - `dumber purge --browser-data` # purge WebKit data (cookies, etc.) | |||
| 258 | - Manage sessions: | 259 | - Manage sessions: | ||
| 259 | - | - `dumber sessions` # interactive session browser (TUI) | 260 | + | - `dumber sessions` # interactive session browser (TUI) |
| 260 | - | - `dumber sessions list` # list saved sessions | 261 | + | - `dumber sessions list` # list saved sessions |
| 261 | - | - `dumber sessions list --json` # output sessions as JSON | 262 | + | - `dumber sessions list --json` # output sessions as JSON |
| 262 | - | - `dumber sessions restore <id>` # restore a session in new window | 263 | + | - `dumber sessions list --limit 50` # limit number of sessions shown |
| 263 | - | - `dumber sessions delete <id>` # delete a saved session | 264 | + | - `dumber sessions restore <id>` # restore a session in a new window |
| 265 | + | - `dumber sessions delete <id>` # delete a saved session | |||
| 264 | - Manage logs: | 266 | - Manage logs: | ||
| 265 | - | - `dumber logs list` # list available log files | 267 | + | - `dumber logs` # list sessions with log files |
| 266 | - | - `dumber logs tail` # tail current log file | 268 | + | - `dumber logs <session>` # show logs for a session (full ID or unique suffix) |
| 267 | - | - `dumber logs clean` # clean up old log files | 269 | + | - `dumber logs -f <session>` # follow logs in real time |
| 270 | + | - `dumber logs -n 200 <session>` # show last N lines | |||
| 271 | + | - `dumber logs clear` # clean up old log files | |||
| 272 | + | - `dumber logs clear --all` # remove all log files | |||
| 268 | 273 | ||||
| 269 | ### Dmenu mode invocation | 274 | ### Dmenu mode invocation | ||
| 270 | You can invoke dmenu mode in two ways: | 275 | You can invoke dmenu mode in two ways: | ||
| 271 | - | - Subcommand (recommended): `dumber dmenu` … and `dumber dmenu --select` | 276 | + | - Piped launcher (generate options): `dumber dmenu` |
| 272 | - | - Root flag (generate options only): `dumber --dmenu` | 277 | + | - Receive selection from stdin: `dumber dmenu --select` |
| 273 | 278 | ||||
| 274 | - | Note: The root flag path only generates options; for processing a selection (`--select`), use the `dmenu` subcommand as the receiving command. | 279 | + | For a built-in fuzzy finder UI, use: `dumber dmenu --interactive` |
| 275 | 280 | ||||
| 276 | In GUI mode the app serves an embedded home page via `dumb://home`, and frontend assets under `dumb://app/...`. | 281 | In GUI mode the app serves an embedded home page via `dumb://home`, and frontend assets under `dumb://app/...`. | ||
| 277 | 282 | ||||