From d4c40519e551697e242224d98c3ebfb6deb54321 Mon Sep 17 00:00:00 2001 From: Gitea Actions Date: Tue, 8 Sep 2026 16:50:35 +0000 Subject: [PATCH] chore(docs): regenerate manual, man page, and component registry --- docs/fish-config.1 | 122 +++++++++++++++++++++++++++++++++++++++++--- docs/fish-config.md | 112 ++++++++++++++++++++++++++++++++++++++-- 2 files changed, 224 insertions(+), 10 deletions(-) diff --git a/docs/fish-config.1 b/docs/fish-config.1 index 5353f26..70b432d 100644 --- a/docs/fish-config.1 +++ b/docs/fish-config.1 @@ -78,7 +78,6 @@ The configuration uses a structured file tree: ├── conf.d/ │ ├── abbr.fish All abbreviations │ ├── autopair.fish Auto-pair brackets and quotes -│ ├── cheat.fish cheat.sh tab completions │ ├── done.fish Desktop notifications for long commands │ ├── first_run.fish One-time init: Fisher bootstrap, theme │ ├── key_bindings.fish Custom key bindings and Vi mode @@ -90,14 +89,13 @@ The configuration uses a structured file tree: │ ├── zellij-logging.fish C5 fish_exit handler for zellij │ ├── sponge_privacy.fish Sponge privacy patterns │ ├── starship.fish fish_prompt shell-integration markers -│ ├── tailscale.fish Tailscale CLI tab completions │ ├── theme.fish Catppuccin syntax highlight colors │ ├── tricks.fish PATH, bang-bang helpers, bat man pages │ ├── wakatime.fish WakaTime shell hook │ ├── yay-wrapper.fish Auto-generates yay logging wrapper │ └── zoxide.fish Zoxide z/zi integration; overrides cd ├── functions/ Custom functions, one per file -├── completions/ Tab completion scripts +├── completions/ Tab completion scripts, autoloaded on demand ├── integrations/ │ └── fzf.fish FZF Catppuccin theme and key bindings ├── scripts/ @@ -439,7 +437,8 @@ plugin. .SS Tailscale .PP Full tab completion for the \f[V]tailscale\f[R] CLI is provided via -\f[V]conf.d/tailscale.fish\f[R]. +\f[V]completions/tailscale.fish\f[R], autoloaded on the first +\f[V]tailscale\f[R]. .SS Done Notifications .PP Desktop notifications fire when a command takes longer than 10 seconds @@ -978,6 +977,9 @@ falls back to lsd, then to system ls. Arguments: args... Arguments forwarded to the listing command +Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lD \[ti]/projects \f[R] @@ -1012,6 +1014,9 @@ per line with icons. Uses eza, falls back to lsd, then to system ls. Arguments: args... Arguments forwarded to the listing command +Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lsr \[ti]/projects \f[R] @@ -1028,6 +1033,9 @@ Uses eza, falls back to lsd, then to system ls. Arguments: args... Arguments forwarded to the listing command +Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lss \[ti]/downloads \f[R] @@ -1044,6 +1052,9 @@ Uses eza, falls back to lsd, then to system ls -R. Arguments: args... Arguments forwarded to the listing command +Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lstree \[ti]/projects/myapp \f[R] @@ -1060,6 +1071,9 @@ falls back to lsd, then to system ls -R. Arguments: args... Arguments forwarded to the listing command +Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lt \[ti]/projects \f[R] @@ -1077,6 +1091,9 @@ to lsd, then to system ls. Arguments: args... Arguments forwarded to the listing command +Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: ltr \[ti]/projects \f[R] @@ -1093,6 +1110,9 @@ eza, falls back to lsd, then to system ls -lX. Arguments: args... Arguments forwarded to the listing command +Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lx \[ti]/projects \f[R] @@ -1599,6 +1619,10 @@ Synopsis: hist Searches fish history interactively using fzf, inserts the selected command into the command line, and copies it to the clipboard via wl-copy. +Exit Status: + 0 Command selected and inserted, or fzf was cancelled + 1 Disabled by __fish_config_op_integrations + Example: hist \f[R] @@ -1613,6 +1637,10 @@ Synopsis: cleanup Identifies and removes Arch Linux orphan packages using pacman. Logs package names and versions to \[ti]/.removed_orphans before removal. +Exit Status: + 0 No orphans found, or orphans removed successfully + Nonzero sudo pacman -Rns failed + Example: cleanup \f[R] @@ -1717,6 +1745,9 @@ Synopsis: check_fish_deps Backwards-compatibility wrapper that delegates to fish-deps status to report which fish shell dependencies are installed or missing. +Exit Status: + Exit status of fish-deps status + Example: check_fish_deps \f[R] @@ -1787,6 +1818,10 @@ Synopsis: fzf-update Installs or upgrades fzf from git HEAD into \[ti]/.fzf. Pulls the latest changes if \[ti]/.fzf already exists, or clones the repository if not. +Exit Status: + 0 fzf installed or updated successfully + Nonzero git or the fzf install script failed + Example: fzf-update \f[R] @@ -1803,6 +1838,9 @@ runs CachyOS boot hooks (limine-mkinitcpio), and re-signs all Secure Boot files tracked by sbctl. Combines the edit and sign steps into a single command. +Exit Status: + 0 Always (individual step failures are not propagated) + Example: limine-edit \f[R] @@ -1815,6 +1853,9 @@ Synopsis: lock Locks the current desktop session using loginctl lock-session. +Exit Status: + Exit status of loginctl lock-session + Example: lock \f[R] @@ -1828,6 +1869,9 @@ Synopsis: ports Lists all active TCP listeners on the system using lsof, showing port numbers and addresses without hostname resolution. +Exit Status: + Exit status of lsof + Example: ports \f[R] @@ -1864,6 +1908,9 @@ Synopsis: screensleep Turns off the display after a 1-second delay by invoking the KDE PowerDevil \[dq]Turn Off Screen\[dq] global shortcut via busctl. +Exit Status: + Exit status of busctl + Example: screensleep \f[R] @@ -1896,6 +1943,9 @@ Displays a colorized memory report showing kernel swappiness, zRAM compression ratio, zRAM device details (via zramctl), and active swap priority (via swapon). +Exit Status: + 0 Always + Example: swapstat \f[R] @@ -2250,6 +2300,9 @@ Synopsis: fast Displays a styled message indicating that the fast command is unavailable and suggests using fast-cli instead. +Exit Status: + 0 Always + Example: fast \f[R] @@ -2278,6 +2331,9 @@ Synopsis: gip Fetches and prints both the public IPv4 and IPv6 addresses using icanhazip.com. Shows \[dq]Not detected\[dq] for any address that times out. +Exit Status: + 0 Always (network failures print \[dq]Not detected\[dq] instead of failing) + Example: gip \f[R] @@ -2290,6 +2346,9 @@ Synopsis: gip4 Fetches and prints the machine\[aq]s public IPv4 address using icanhazip.com. +Exit Status: + Exit status of curl + Example: gip4 \f[R] @@ -2346,6 +2405,9 @@ falls back to the qrenco.de API via curl. Arguments: text... Text to encode; reads from stdin if omitted +Exit Status: + Exit status of qrencode, or curl if qrencode is unavailable + Example: qr \[dq]https://example.com\[dq] echo \[dq]hello\[dq] | qr @@ -2819,6 +2881,9 @@ Invokes Claude Code to analyze recent repository changes and update README.md, ensuring all features and examples are accurate and pruning obsolete content. +Exit Status: + Exit status of the claude invocation + Example: claude-docs \f[R] @@ -2833,28 +2898,65 @@ Invokes Claude Code to perform a full PR workflow: create a kebab-case branch, write a Conventional Commit, run verification, push, and open a pull request with a manual verification checklist. +Exit Status: + Exit status of the claude invocation + Example: claude-pr \f[R] .fi -.SS dops +.SS docker .IP .nf \f[C] Synopsis: docker [subcommand] [args...] Wrapper for docker that intercepts the ps subcommand and redirects it to -the dops function for enhanced container listing. All other subcommands are -passed through to the real docker binary. +the dops function for enhanced container listing. All other subcommands, +and a bare invocation with no subcommand, are passed through to the real +docker binary. Arguments: subcommand Docker subcommand (ps is redirected to dops) args... Arguments forwarded to docker or dops +Exit Status: + Exit status of dops (for ps), or of the real docker binary otherwise + Example: docker ps +docker \f[R] .fi +.PP +\f[B]Dependencies:\f[R] \f[V]dops\f[R] +.PP +\f[B]Used by:\f[R] \f[V]dops\f[R] +.SS dops +.IP +.nf +\f[C] +Synopsis: dops [args...] + +Enhanced container listing: runs docker ps with a clean custom table +(Names, Image, Status, Ports) instead of docker\[aq]s noisier default +columns. Extra arguments (e.g. -a) are forwarded to docker ps. + +Arguments: + args... Arguments forwarded to docker ps + +Exit Status: + Exit status of docker ps + +Example: +dops +dops -a +\f[R] +.fi +.PP +\f[B]Dependencies:\f[R] \f[V]docker\f[R] +.PP +\f[B]Used by:\f[R] \f[V]docker\f[R] .SS qc .IP .nf @@ -3003,6 +3105,9 @@ Synopsis: steam-dl Launches Steam with systemd-inhibit to prevent the system from idling or sleeping during active downloads. +Exit Status: + Exit status of steam (via systemd-inhibit) + Example: steam-dl \f[R] @@ -3574,6 +3679,9 @@ Synopsis: tmux-clean Kills all detached (unattached) tmux sessions, leaving any currently attached sessions running. +Exit Status: + 0 Always + Example: tmux-clean \f[R] diff --git a/docs/fish-config.md b/docs/fish-config.md index 5edcf39..3d9d63c 100644 --- a/docs/fish-config.md +++ b/docs/fish-config.md @@ -661,6 +661,9 @@ functions). They are active in all interactive sessions. Arguments: args... Arguments forwarded to the listing command + Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lD ~/projects @@ -689,6 +692,9 @@ functions). They are active in all interactive sessions. Arguments: args... Arguments forwarded to the listing command + Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lsr ~/projects @@ -702,6 +708,9 @@ functions). They are active in all interactive sessions. Arguments: args... Arguments forwarded to the listing command + Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lss ~/downloads @@ -715,6 +724,9 @@ functions). They are active in all interactive sessions. Arguments: args... Arguments forwarded to the listing command + Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lstree ~/projects/myapp @@ -728,6 +740,9 @@ functions). They are active in all interactive sessions. Arguments: args... Arguments forwarded to the listing command + Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lt ~/projects @@ -742,6 +757,9 @@ functions). They are active in all interactive sessions. Arguments: args... Arguments forwarded to the listing command + Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: ltr ~/projects @@ -755,6 +773,9 @@ functions). They are active in all interactive sessions. Arguments: args... Arguments forwarded to the listing command + Exit Status: + Exit status of eza, lsd, or ls, whichever ran + Example: lx ~/projects @@ -1198,6 +1219,10 @@ functions). They are active in all interactive sessions. Searches fish history interactively using fzf, inserts the selected command into the command line, and copies it to the clipboard via wl-copy. + Exit Status: + 0 Command selected and inserted, or fzf was cancelled + 1 Disabled by __fish_config_op_integrations + Example: hist @@ -1210,6 +1235,10 @@ functions). They are active in all interactive sessions. Identifies and removes Arch Linux orphan packages using pacman. Logs package names and versions to ~/.removed_orphans before removal. + Exit Status: + 0 No orphans found, or orphans removed successfully + Nonzero sudo pacman -Rns failed + Example: cleanup @@ -1300,6 +1329,9 @@ functions). They are active in all interactive sessions. Backwards-compatibility wrapper that delegates to fish-deps status to report which fish shell dependencies are installed or missing. + Exit Status: + Exit status of fish-deps status + Example: check_fish_deps @@ -1364,6 +1396,10 @@ functions). They are active in all interactive sessions. Installs or upgrades fzf from git HEAD into ~/.fzf. Pulls the latest changes if ~/.fzf already exists, or clones the repository if not. + Exit Status: + 0 fzf installed or updated successfully + Nonzero git or the fzf install script failed + Example: fzf-update @@ -1378,6 +1414,9 @@ functions). They are active in all interactive sessions. files tracked by sbctl. Combines the edit and sign steps into a single command. + Exit Status: + 0 Always (individual step failures are not propagated) + Example: limine-edit @@ -1387,6 +1426,9 @@ functions). They are active in all interactive sessions. Locks the current desktop session using loginctl lock-session. + Exit Status: + Exit status of loginctl lock-session + Example: lock @@ -1397,6 +1439,9 @@ functions). They are active in all interactive sessions. Lists all active TCP listeners on the system using lsof, showing port numbers and addresses without hostname resolution. + Exit Status: + Exit status of lsof + Example: ports @@ -1427,6 +1472,9 @@ functions). They are active in all interactive sessions. Turns off the display after a 1-second delay by invoking the KDE PowerDevil "Turn Off Screen" global shortcut via busctl. + Exit Status: + Exit status of busctl + Example: screensleep @@ -1453,6 +1501,9 @@ functions). They are active in all interactive sessions. zRAM compression ratio, zRAM device details (via zramctl), and active swap priority (via swapon). + Exit Status: + 0 Always + Example: swapstat @@ -1761,6 +1812,9 @@ functions). They are active in all interactive sessions. Displays a styled message indicating that the fast command is unavailable and suggests using fast-cli instead. + Exit Status: + 0 Always + Example: fast @@ -1783,6 +1837,9 @@ functions). They are active in all interactive sessions. Fetches and prints both the public IPv4 and IPv6 addresses using icanhazip.com. Shows "Not detected" for any address that times out. + Exit Status: + 0 Always (network failures print "Not detected" instead of failing) + Example: gip @@ -1792,6 +1849,9 @@ functions). They are active in all interactive sessions. Fetches and prints the machine's public IPv4 address using icanhazip.com. + Exit Status: + Exit status of curl + Example: gip4 @@ -1839,6 +1899,9 @@ functions). They are active in all interactive sessions. Arguments: text... Text to encode; reads from stdin if omitted + Exit Status: + Exit status of qrencode, or curl if qrencode is unavailable + Example: qr "https://example.com" echo "hello" | qr @@ -2283,6 +2346,9 @@ functions). They are active in all interactive sessions. README.md, ensuring all features and examples are accurate and pruning obsolete content. + Exit Status: + Exit status of the claude invocation + Example: claude-docs @@ -2294,23 +2360,57 @@ functions). They are active in all interactive sessions. branch, write a Conventional Commit, run verification, push, and open a pull request with a manual verification checklist. + Exit Status: + Exit status of the claude invocation + Example: claude-pr -### dops +### docker Synopsis: docker [subcommand] [args...] Wrapper for docker that intercepts the ps subcommand and redirects it to - the dops function for enhanced container listing. All other subcommands are - passed through to the real docker binary. + the dops function for enhanced container listing. All other subcommands, + and a bare invocation with no subcommand, are passed through to the real + docker binary. Arguments: subcommand Docker subcommand (ps is redirected to dops) args... Arguments forwarded to docker or dops + Exit Status: + Exit status of dops (for ps), or of the real docker binary otherwise + Example: docker ps + docker + +**Dependencies:** `dops` + +**Used by:** `dops` + +### dops + + Synopsis: dops [args...] + + Enhanced container listing: runs docker ps with a clean custom table + (Names, Image, Status, Ports) instead of docker's noisier default + columns. Extra arguments (e.g. -a) are forwarded to docker ps. + + Arguments: + args... Arguments forwarded to docker ps + + Exit Status: + Exit status of docker ps + + Example: + dops + dops -a + +**Dependencies:** `docker` + +**Used by:** `docker` ### qc @@ -2444,6 +2544,9 @@ functions). They are active in all interactive sessions. Launches Steam with systemd-inhibit to prevent the system from idling or sleeping during active downloads. + Exit Status: + Exit status of steam (via systemd-inhibit) + Example: steam-dl @@ -2956,6 +3059,9 @@ functions). They are active in all interactive sessions. Kills all detached (unattached) tmux sessions, leaving any currently attached sessions running. + Exit Status: + 0 Always + Example: tmux-clean