rootiest/fish-config
1
1
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

chore(docs): regenerate man page, HTML docs, and wiki

Browse Source
This commit is contained in:
Gitea Actions
2026-06-23 18:28:57 +00:00
parent f6fd093850
commit cd240f4460
11 changed files with 125 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/fish-config.1
+39 -14
View File
@@ -80,7 +80,7 @@ Nothing leaves your machine, but the files persist locally.
Disable all logging with: \f[V]set -U __fish_config_op_logging off\f[R] Disable all logging with: \f[V]set -U __fish_config_op_logging off\f[R]
.IP \[bu] 2 .IP \[bu] 2
Prefer a menu? Prefer a menu?
Run the interactive picker: \f[V]config-toggle\f[R] Run the interactive picker: \f[V]config-settings\f[R]
.IP \[bu] 2 .IP \[bu] 2
See Section 7 (C5 - Logging and Capture) for the full breakdown. See Section 7 (C5 - Logging and Capture) for the full breakdown.
.RE .RE
@@ -1705,21 +1705,26 @@ config-update --dry-run
config-update --force config-update --force
\f[R] \f[R]
.fi .fi
.SS config-toggle .SS config-settings
.IP .IP
.nf .nf
\f[C] \f[C]
Synopsis: config-toggle [-h] Synopsis: config-settings [-h]
Opens an interactive TUI for toggling the six opinionated component Opens an interactive TUI for managing fish configuration settings. Handles
categories (C1\[en]C6) and the master disable variable without having to the six opinionated component categories (C1\[en]C6), the master disable
type or remember variable names. Two scope tabs allow independent variable, and the __fish_user_dots_path path variable \[em] without having to
per-scope configuration: type or remember variable names. Two scope tabs allow independent per-scope
configuration for category toggles:
Universal \[em] persists across all sessions (set -U) Universal \[em] persists across all sessions (set -U)
Session \[em] current shell only (set -g) Session \[em] current shell only (set -g)
Changes apply immediately on each value keypress. Always available The Dots Path row always operates on the universal scope regardless of the
active tab.
Changes to category toggles apply immediately on each keypress. Changes to
the path variable use an inline edit prompt (Enter). Always available
regardless of the __fish_config_opinionated master state. regardless of the __fish_config_opinionated master state.
The panel adapts to the terminal width automatically, selecting from The panel adapts to the terminal width automatically, selecting from
@@ -1734,17 +1739,33 @@ redraws within \[ti]0.3 s of a terminal resize with no keypress required.
Navigation: Navigation:
↑ ↓ / k j Move cursor ↑ ↓ / k j Move cursor
← → / h l Set value: OFF ← DEFAULT → ON (clamped) ← → / h l Set value: OFF ← DEFAULT → ON (toggle rows); LEFT clears path
Enter Edit the Dots Path (path row only)
Tab Switch scope (Universal ↔ Session) Tab Switch scope (Universal ↔ Session)
q / Escape Exit q / Escape Exit
Left/Right (or vim-style h/l) move the highlighted value one step along Left/Right (or vim-style h/l) move the highlighted toggle value one step
the OFF\[en]DEFAULT\[en]ON scale and stop at the ends. DEFAULT erases the along the OFF\[en]DEFAULT\[en]ON scale and stop at the ends. DEFAULT erases the
variable so the master switch / built-in default applies. variable so the master switch / built-in default applies. On the Dots Path
row, LEFT/h clears the universal variable; RIGHT/l is a no-op (use Enter).
Dots Path row [U] tag: the tag confirms this row always writes to the
universal scope, regardless of which tab is active. Setting it per-session
would have no effect on startup sourcing.
Flags: Flags:
--help / -h Show usage. --help / -h Show usage.
config-settings
\f[R]
.fi
.SS config-toggle (deprecated)
.IP
.nf
\f[C]
Deprecated alias for config-settings. Prints a deprecation notice to
stderr, then delegates all arguments to config-settings.
config-toggle config-toggle
\f[R] \f[R]
.fi .fi
@@ -2090,8 +2111,8 @@ set -U __fish_config_op_greeting 1
.fi .fi
.PP .PP
For an interactive alternative to setting these variables by hand, run For an interactive alternative to setting these variables by hand, run
config-toggle \[em] a full-screen TUI that flips any category (including config-settings \[em] a full-screen TUI that flips any category
C5 logging) on or off, per session or universally. (including C5 logging) on or off, per session or universally.
See its entry in Section 5. See its entry in Section 5.
.PP .PP
Notes: Notes:
@@ -2643,6 +2664,10 @@ set -U __fish_user_dots_path /path/to/your/dots/fish
\f[R] \f[R]
.fi .fi
.PP .PP
Or use the interactive TUI \[em] run \f[V]config-settings\f[R] and
navigate to the \[lq]Dots Path\[rq] row (last row).
Press Enter to type a new path, or ← / h to reset to the default.
.PP
config.fish sources local.fish from that directory on every interactive config.fish sources local.fish from that directory on every interactive
session. session.
local.fish is responsible for sourcing its own secrets.fish: local.fish is responsible for sourcing its own secrets.fish:
docs/html/11-7-customization.html
+3 -3
View File
@@ -582,9 +582,9 @@ set -U __fish_config_opinionated 0
set -U __fish_config_op_greeting 1 set -U __fish_config_op_greeting 1
# (erase both to go back to full-flavor defaults)</code></pre> # (erase both to go back to full-flavor defaults)</code></pre>
<p>For an interactive alternative to setting these variables by hand, <p>For an interactive alternative to setting these variables by hand,
run config-toggle — a full-screen TUI that flips any category (including run config-settings — a full-screen TUI that flips any category
C5 logging) on or off, per session or universally. See its entry in (including C5 logging) on or off, per session or universally. See its
Section 5.</p> entry in Section 5.</p>
<p>Notes:</p> <p>Notes:</p>
<ul> <ul>
<li>Command shadows (rm, cat, ls, ...) react immediately; conf.d-level <li>Command shadows (rm, cat, ls, ...) react immediately; conf.d-level
docs/html/14-10-personalization.html
+3
View File
@@ -493,6 +493,9 @@
version control in a private directory. The path defaults to version control in a private directory. The path defaults to
<code>~/.config/.user-dots/fish/</code> but can be overridden:</p> <code>~/.config/.user-dots/fish/</code> but can be overridden:</p>
<pre><code>set -U __fish_user_dots_path /path/to/your/dots/fish</code></pre> <pre><code>set -U __fish_user_dots_path /path/to/your/dots/fish</code></pre>
<p>Or use the interactive TUI — run <code>config-settings</code> and
navigate to the "Dots Path" row (last row). Press Enter to type a new
path, or ← / h to reset to the default.</p>
<p>config.fish sources local.fish from that directory on every <p>config.fish sources local.fish from that directory on every
interactive session. local.fish is responsible for sourcing its own interactive session. local.fish is responsible for sourcing its own
secrets.fish:</p> secrets.fish:</p>
docs/html/3-description.html
+1 -1
View File
@@ -516,7 +516,7 @@ files persist locally.</p>
<li>Disable all logging with: <li>Disable all logging with:
<code>set -U __fish_config_op_logging off</code></li> <code>set -U __fish_config_op_logging off</code></li>
<li>Prefer a menu? Run the interactive picker: <li>Prefer a menu? Run the interactive picker:
<code>config-toggle</code></li> <code>config-settings</code></li>
<li>See Section 7 (C5 - Logging and Capture) for the full <li>See Section 7 (C5 - Logging and Capture) for the full
breakdown.</li> breakdown.</li>
</ul> </ul>
docs/html/9-5-functions-reference.html
+39 -22
View File
@@ -1155,18 +1155,23 @@ Flags:
config-update config-update
config-update --dry-run config-update --dry-run
config-update --force</code></pre> config-update --force</code></pre>
<h3 data-number="9.14.3" id="config-toggle">config-toggle</h3> <h3 data-number="9.14.3" id="config-settings">config-settings</h3>
<pre><code>Synopsis: config-toggle [-h] <pre><code>Synopsis: config-settings [-h]
Opens an interactive TUI for toggling the six opinionated component Opens an interactive TUI for managing fish configuration settings. Handles
categories (C1–C6) and the master disable variable without having to the six opinionated component categories (C1–C6), the master disable
type or remember variable names. Two scope tabs allow independent variable, and the __fish_user_dots_path path variable — without having to
per-scope configuration: type or remember variable names. Two scope tabs allow independent per-scope
configuration for category toggles:
Universal — persists across all sessions (set -U) Universal — persists across all sessions (set -U)
Session — current shell only (set -g) Session — current shell only (set -g)
Changes apply immediately on each value keypress. Always available The Dots Path row always operates on the universal scope regardless of the
active tab.
Changes to category toggles apply immediately on each keypress. Changes to
the path variable use an inline edit prompt (Enter). Always available
regardless of the __fish_config_opinionated master state. regardless of the __fish_config_opinionated master state.
The panel adapts to the terminal width automatically, selecting from The panel adapts to the terminal width automatically, selecting from
@@ -1181,56 +1186,68 @@ redraws within ~0.3 s of a terminal resize with no keypress required.
Navigation: Navigation:
↑ ↓ / k j Move cursor ↑ ↓ / k j Move cursor
← → / h l Set value: OFF ← DEFAULT → ON (clamped) ← → / h l Set value: OFF ← DEFAULT → ON (toggle rows); LEFT clears path
Enter Edit the Dots Path (path row only)
Tab Switch scope (Universal ↔ Session) Tab Switch scope (Universal ↔ Session)
q / Escape Exit q / Escape Exit
Left/Right (or vim-style h/l) move the highlighted value one step along Left/Right (or vim-style h/l) move the highlighted toggle value one step
the OFF–DEFAULT–ON scale and stop at the ends. DEFAULT erases the along the OFF–DEFAULT–ON scale and stop at the ends. DEFAULT erases the
variable so the master switch / built-in default applies. variable so the master switch / built-in default applies. On the Dots Path
row, LEFT/h clears the universal variable; RIGHT/l is a no-op (use Enter).
Dots Path row [U] tag: the tag confirms this row always writes to the
universal scope, regardless of which tab is active. Setting it per-session
would have no effect on startup sourcing.
Flags: Flags:
--help / -h Show usage. --help / -h Show usage.
config-settings</code></pre>
<h3 data-number="9.14.4" id="config-toggle-deprecated">config-toggle
(deprecated)</h3>
<pre><code>Deprecated alias for config-settings. Prints a deprecation notice to
stderr, then delegates all arguments to config-settings.
config-toggle</code></pre> config-toggle</code></pre>
<h3 data-number="9.14.4" id="bash">bash</h3> <h3 data-number="9.14.5" id="bash">bash</h3>
<pre><code>Synopsis: bash [args...] <pre><code>Synopsis: bash [args...]
Switches to bash, with XDG config applied. On exit, $SHELL is reset Switches to bash, with XDG config applied. On exit, $SHELL is reset
back to fish.</code></pre> back to fish.</code></pre>
<h3 data-number="9.14.5" id="bd-pull">bd-pull</h3> <h3 data-number="9.14.6" id="bd-pull">bd-pull</h3>
<pre><code>Synopsis: bd-pull &lt;owner/repo&gt; <pre><code>Synopsis: bd-pull &lt;owner/repo&gt;
Fetches unlinked Gitea issues and creates local Beads entries, updating Fetches unlinked Gitea issues and creates local Beads entries, updating
issue titles with the assigned Beads IDs. issue titles with the assigned Beads IDs.
Requires $GITEA_TOKEN and $GITEA_URL to be set. Requires $GITEA_TOKEN and $GITEA_URL to be set.
bd-pull rootiest/fish-config</code></pre> bd-pull rootiest/fish-config</code></pre>
<h3 data-number="9.14.6" id="cheat">cheat</h3> <h3 data-number="9.14.7" id="cheat">cheat</h3>
<pre><code>Synopsis: cheat &lt;topic&gt; [args...] <pre><code>Synopsis: cheat &lt;topic&gt; [args...]
Displays a colorized cheatsheet using cheat -c, falls back to tldr, Displays a colorized cheatsheet using cheat -c, falls back to tldr,
then man. then man.
cheat tar cheat tar
cheat git</code></pre> cheat git</code></pre>
<h3 data-number="9.14.7" id="cffetch--ffetch">cffetch / ffetch</h3> <h3 data-number="9.14.8" id="cffetch--ffetch">cffetch / ffetch</h3>
<pre><code>Synopsis: cffetch [args...] / ffetch [args...] <pre><code>Synopsis: cffetch [args...] / ffetch [args...]
Clears the screen and displays system information via fastfetch with Clears the screen and displays system information via fastfetch with
the custom config at ~/.fastfetch.jsonc. Falls back to neofetch.</code></pre> the custom config at ~/.fastfetch.jsonc. Falls back to neofetch.</code></pre>
<h3 data-number="9.14.8" id="dockup">dockup</h3> <h3 data-number="9.14.9" id="dockup">dockup</h3>
<pre><code>Synopsis: dockup [-h] [directory] <pre><code>Synopsis: dockup [-h] [directory]
Pulls latest Docker images, restarts services in the given Docker Pulls latest Docker images, restarts services in the given Docker
Compose project, and prunes dangling images. Compose project, and prunes dangling images.
dockup ~/myapp</code></pre> dockup ~/myapp</code></pre>
<h3 data-number="9.14.9" id="joplin">joplin</h3> <h3 data-number="9.14.10" id="joplin">joplin</h3>
<pre><code>Synopsis: joplin [args...] <pre><code>Synopsis: joplin [args...]
Runs the Joplin CLI with Node.js deprecation warnings suppressed. Runs the Joplin CLI with Node.js deprecation warnings suppressed.
joplin ls</code></pre> joplin ls</code></pre>
<h3 data-number="9.14.10" id="ld-1">ld</h3> <h3 data-number="9.14.11" id="ld-1">ld</h3>
<pre><code>Synopsis: ld <pre><code>Synopsis: ld
Launches lazydocker targeting the currently active Docker context, Launches lazydocker targeting the currently active Docker context,
detected via docker context inspect.</code></pre> detected via docker context inspect.</code></pre>
<h3 data-number="9.14.11" id="replay">replay</h3> <h3 data-number="9.14.12" id="replay">replay</h3>
<pre><code>Synopsis: replay &lt;commands&gt; <pre><code>Synopsis: replay &lt;commands&gt;
Runs Bash commands and replays any resulting changes to environment Runs Bash commands and replays any resulting changes to environment
variables, aliases, and the working directory back into the current variables, aliases, and the working directory back into the current
@@ -1238,7 +1255,7 @@ Fish session. Useful for sourcing Bash scripts.
replay &quot;source ~/.bashrc&quot; replay &quot;source ~/.bashrc&quot;
replay &quot;export FOO=bar&quot;</code></pre> replay &quot;export FOO=bar&quot;</code></pre>
<h3 data-number="9.14.12" id="kitty-logging">kitty-logging</h3> <h3 data-number="9.14.13" id="kitty-logging">kitty-logging</h3>
<pre><code>Synopsis: kitty-logging [install|uninstall|status|dismiss] [-h] <pre><code>Synopsis: kitty-logging [install|uninstall|status|dismiss] [-h]
Manages the Kitty scrollback watcher that powers C5 logging. Ships a Manages the Kitty scrollback watcher that powers C5 logging. Ships a
@@ -1259,11 +1276,11 @@ uninstalling. Install affects new Kitty windows only.
Example: Example:
kitty-logging install kitty-logging install
kitty-logging status</code></pre> kitty-logging status</code></pre>
<h3 data-number="9.14.13" id="tmux-clean">tmux-clean</h3> <h3 data-number="9.14.14" id="tmux-clean">tmux-clean</h3>
<pre><code>Synopsis: tmux-clean <pre><code>Synopsis: tmux-clean
Kills all detached (unattached) tmux sessions, leaving attached ones Kills all detached (unattached) tmux sessions, leaving attached ones
running.</code></pre> running.</code></pre>
<h3 data-number="9.14.14" id="wake-lock">wake-lock</h3> <h3 data-number="9.14.15" id="wake-lock">wake-lock</h3>
<pre><code>Synopsis: wake-lock &lt;command&gt; [args...] <pre><code>Synopsis: wake-lock &lt;command&gt; [args...]
Runs a command under systemd-inhibit, preventing the system from going Runs a command under systemd-inhibit, preventing the system from going
idle or sleeping until the command completes. idle or sleeping until the command completes.
docs/html/index.html
+4 -2
View File
@@ -771,8 +771,10 @@ id="toc-514-miscellaneous">5.14 Miscellaneous</a>
id="toc-config-help">config-help</a></li> id="toc-config-help">config-help</a></li>
<li><a href="9-5-functions-reference.html#config-update" <li><a href="9-5-functions-reference.html#config-update"
id="toc-config-update">config-update</a></li> id="toc-config-update">config-update</a></li>
<li><a href="9-5-functions-reference.html#config-toggle" <li><a href="9-5-functions-reference.html#config-settings"
id="toc-config-toggle">config-toggle</a></li> id="toc-config-settings">config-settings</a></li>
<li><a href="9-5-functions-reference.html#config-toggle-deprecated"
id="toc-config-toggle-deprecated">config-toggle (deprecated)</a></li>
<li><a href="9-5-functions-reference.html#bash" <li><a href="9-5-functions-reference.html#bash"
id="toc-bash">bash</a></li> id="toc-bash">bash</a></li>
<li><a href="9-5-functions-reference.html#bd-pull" <li><a href="9-5-functions-reference.html#bd-pull"
docs/html/sitemap.json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/wiki/10-personalization.md
+4
View File
@@ -10,6 +10,10 @@ control in a private directory. The path defaults to
set -U __fish_user_dots_path /path/to/your/dots/fish set -U __fish_user_dots_path /path/to/your/dots/fish
Or use the interactive TUI — run `config-settings` and navigate to the
"Dots Path" row (last row). Press Enter to type a new path, or ← / h to
reset to the default.
config.fish sources local.fish from that directory on every interactive config.fish sources local.fish from that directory on every interactive
session. local.fish is responsible for sourcing its own secrets.fish: session. local.fish is responsible for sourcing its own secrets.fish:
docs/wiki/5-functions-reference.md
+29 -11
View File
@@ -840,19 +840,24 @@
config-update --dry-run config-update --dry-run
config-update --force config-update --force
### config-toggle ### config-settings
Synopsis: config-toggle [-h] Synopsis: config-settings [-h]
Opens an interactive TUI for toggling the six opinionated component Opens an interactive TUI for managing fish configuration settings. Handles
categories (C1–C6) and the master disable variable without having to the six opinionated component categories (C1–C6), the master disable
type or remember variable names. Two scope tabs allow independent variable, and the __fish_user_dots_path path variable — without having to
per-scope configuration: type or remember variable names. Two scope tabs allow independent per-scope
configuration for category toggles:
Universal — persists across all sessions (set -U) Universal — persists across all sessions (set -U)
Session — current shell only (set -g) Session — current shell only (set -g)
Changes apply immediately on each value keypress. Always available The Dots Path row always operates on the universal scope regardless of the
active tab.
Changes to category toggles apply immediately on each keypress. Changes to
the path variable use an inline edit prompt (Enter). Always available
regardless of the __fish_config_opinionated master state. regardless of the __fish_config_opinionated master state.
The panel adapts to the terminal width automatically, selecting from The panel adapts to the terminal width automatically, selecting from
@@ -867,17 +872,30 @@
Navigation: Navigation:
↑ ↓ / k j Move cursor ↑ ↓ / k j Move cursor
← → / h l Set value: OFF ← DEFAULT → ON (clamped) ← → / h l Set value: OFF ← DEFAULT → ON (toggle rows); LEFT clears path
Enter Edit the Dots Path (path row only)
Tab Switch scope (Universal ↔ Session) Tab Switch scope (Universal ↔ Session)
q / Escape Exit q / Escape Exit
Left/Right (or vim-style h/l) move the highlighted value one step along Left/Right (or vim-style h/l) move the highlighted toggle value one step
the OFF–DEFAULT–ON scale and stop at the ends. DEFAULT erases the along the OFF–DEFAULT–ON scale and stop at the ends. DEFAULT erases the
variable so the master switch / built-in default applies. variable so the master switch / built-in default applies. On the Dots Path
row, LEFT/h clears the universal variable; RIGHT/l is a no-op (use Enter).
Dots Path row [U] tag: the tag confirms this row always writes to the
universal scope, regardless of which tab is active. Setting it per-session
would have no effect on startup sourcing.
Flags: Flags:
--help / -h Show usage. --help / -h Show usage.
config-settings
### config-toggle (deprecated)
Deprecated alias for config-settings. Prints a deprecation notice to
stderr, then delegates all arguments to config-settings.
config-toggle config-toggle
### bash ### bash
docs/wiki/7-customization.md
+1 -1
View File
@@ -108,7 +108,7 @@ Examples:
# (erase both to go back to full-flavor defaults) # (erase both to go back to full-flavor defaults)
For an interactive alternative to setting these variables by hand, run For an interactive alternative to setting these variables by hand, run
config-toggle — a full-screen TUI that flips any category (including C5 config-settings — a full-screen TUI that flips any category (including C5
logging) on or off, per session or universally. See its entry in Section 5. logging) on or off, per session or universally. See its entry in Section 5.
Notes: Notes:
docs/wiki/index.md
+1 -1
View File
@@ -21,7 +21,7 @@ A production-grade Fish shell configuration targeting Fish 4.x. It provides:
> your machine, but the files persist locally. > your machine, but the files persist locally.
> >
> - Disable all logging with: `set -U __fish_config_op_logging off` > - Disable all logging with: `set -U __fish_config_op_logging off`
> - Prefer a menu? Run the interactive picker: `config-toggle` > - Prefer a menu? Run the interactive picker: `config-settings`
> - See Section 7 (C5 - Logging and Capture) for the full breakdown. > - See Section 7 (C5 - Logging and Capture) for the full breakdown.
The configuration is split across: The configuration is split across: