chore(docs): regenerate man page, HTML docs, and wiki
This commit is contained in:
Gitea Actions
+89
-14
@@ -354,7 +354,7 @@ Ctrl+Enter Smart execute: runs commands instantly without
|
||||
at the cursor position.
|
||||
\f[R]
|
||||
.fi
|
||||
.SS FZF Bindings (from PatrickF1/fzf.fish)
|
||||
.SS FZF Bindings (bundled from PatrickF1/fzf.fish)
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
@@ -1795,10 +1795,10 @@ Highlights: #F38BA8 (red) #CBA6F7 (mauve) #B4BEFE (lavender)
|
||||
To customize, override FZF_DEFAULT_OPTS in local.fish.
|
||||
.SS Catppuccin Mocha Syntax Highlighting
|
||||
.PP
|
||||
The catppuccin/fish plugin applies syntax highlight colors on first run.
|
||||
The Catppuccin Mocha theme ships with this config in themes/ and is
|
||||
applied on first run via \f[V]conf.d/first_run.fish\f[R].
|
||||
Colors are stored in fish_variables (universal).
|
||||
To switch variants, install a different theme from the themes/
|
||||
directory:
|
||||
To switch variants, install a different theme from themes/:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
@@ -1825,23 +1825,96 @@ set -Ue __fish_config_first_run_complete
|
||||
.fi
|
||||
.PP
|
||||
Then open a new shell.
|
||||
.SS Fisher-Managed Plugins
|
||||
.PP
|
||||
The plugin list is maintained in fish_plugins at the config root.
|
||||
The following plugins are fully managed by Fisher.
|
||||
Their files are installed into the repo directory by Fisher and are
|
||||
listed in \f[V].gitignore\f[R] \[em] do not commit them.
|
||||
Fisher installs and updates them automatically.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
jorgebucaran/fisher Plugin manager itself
|
||||
catppuccin/fish Catppuccin Mocha color theme
|
||||
PatrickF1/fzf.fish fzf integration for Fish
|
||||
franciscolourenco/done Desktop notification when long commands finish
|
||||
jorgebucaran/autopair.fish Auto-pair brackets and quotes
|
||||
meaningful-ooo/sponge Remove failed commands from history
|
||||
nickeb96/puffer-fish !! / !$ / ./ expansion
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Sponge History Filtering
|
||||
.PP
|
||||
Sponge removes failed commands from history and, via
|
||||
conf.d/sponge_privacy.fish, also filters privacy-sensitive commands
|
||||
through three layers:
|
||||
.PP
|
||||
Layer 1 \[em] Static patterns (universal, persistent across sessions):
|
||||
Commands matching any of these structural signatures are never recorded:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
--password / --token / --passphrase / --api-key flags with values
|
||||
Inline env assignments: GITHUB_TOKEN=xxx, MY_API_KEY=abc
|
||||
Fish set with sensitive names: set -gx GITHUB_TOKEN xxx
|
||||
URLs with embedded credentials: https://user:pass\[at]host
|
||||
HTTP Authorization headers: curl -H \[dq]Authorization: ...\[dq]
|
||||
Basic auth flags: curl -u user:pass
|
||||
sshpass, docker login -p, openssl -passin/-passout
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Run \f[V]fisher update\f[R] to update all plugins, or
|
||||
\f[V]fish-deps update\f[R] which calls fisher update as its first step.
|
||||
Layer 2 \[em] Dynamic secret values (session globals, refreshed each
|
||||
login): On the first prompt, after secrets.fish has loaded, the literal
|
||||
values of all exported variables whose names suggest credentials (TOKEN,
|
||||
PASSWORD, SECRET, API_KEY, etc.)
|
||||
are collected, regex-escaped, and added as a session-scoped overlay.
|
||||
Because globals shadow universals in Fish, the combined list is what
|
||||
sponge sees.
|
||||
Rotating a token takes effect on the next login automatically.
|
||||
.PP
|
||||
Layer 3 \[em] Per-command filter (sponge_filter_secrets): Catches
|
||||
credentials in variables exported after login, such as tokens sourced
|
||||
from a project .env file mid-session.
|
||||
.PP
|
||||
To add your own persistent patterns:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
set -U -a sponge_regex_patterns \[aq]your-regex-here\[aq]
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Bundled Plugin Functionality
|
||||
.PP
|
||||
The remaining plugin functionality is bundled directly with this config
|
||||
rather than managed through Fisher.
|
||||
The bundled versions include customizations for Fish 4.x compatibility
|
||||
and improved behavior that differ from their upstream releases.
|
||||
Installing them through Fisher would overwrite these customizations.
|
||||
.PP
|
||||
Bundled components and their upstream origins:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
catppuccin/fish → themes/ + conf.d/theme.fish
|
||||
PatrickF1/fzf.fish → functions/_fzf_*.fish + conf.d/fzf.fish
|
||||
franciscolourenco/done → conf.d/done.fish
|
||||
jorgebucaran/autopair.fish → functions/_autopair_*.fish + conf.d/autopair.fish
|
||||
nickeb96/puffer-fish → functions/_puffer_fish_*.fish + conf.d/puffer.fish
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Do not run \f[V]fisher install\f[R] for these \[em] it will overwrite
|
||||
the customized versions.
|
||||
To update their behavior, edit the relevant bundled files directly.
|
||||
.SS fish_plugins Manifest
|
||||
.PP
|
||||
The \f[V]fish_plugins\f[R] file at the config root:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
jorgebucaran/fisher Plugin manager itself
|
||||
meaningful-ooo/sponge Remove failed commands from history
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
To update all Fisher-managed plugins, run \f[V]fisher update\f[R] or
|
||||
\f[V]fish-deps update\f[R] which calls it as its first step.
|
||||
.PP
|
||||
* * * * *
|
||||
.SH 9. INSTALLATION
|
||||
@@ -1857,8 +1930,10 @@ git clone https://git.rootiest.dev/rootiest/fish-config.git \[ti]/.config/fish
|
||||
.fi
|
||||
.PP
|
||||
Then open a new Fish shell.
|
||||
Fisher and all plugins install automatically on first launch and the
|
||||
Catppuccin Mocha theme is applied.
|
||||
Fisher installs automatically on first launch and the Catppuccin Mocha
|
||||
theme is applied.
|
||||
All other plugin functionality is bundled directly with this config and
|
||||
requires no additional installation.
|
||||
.SS Return Sentinel
|
||||
.PP
|
||||
config.fish ends with a return sentinel guard.
|
||||
|
||||
@@ -536,9 +536,10 @@ Highlights: #F38BA8 (red) #CBA6F7 (mauve) #B4BEFE (lavender)</code></pr
|
||||
<h3 data-number="11.5.3"
|
||||
id="catppuccin-mocha-syntax-highlighting">Catppuccin Mocha Syntax
|
||||
Highlighting</h3>
|
||||
<p>The catppuccin/fish plugin applies syntax highlight colors on first
|
||||
run. Colors are stored in fish_variables (universal). To switch
|
||||
variants, install a different theme from the themes/ directory:</p>
|
||||
<p>The Catppuccin Mocha theme ships with this config in themes/ and is
|
||||
applied on first run via <code>conf.d/first_run.fish</code>. Colors are
|
||||
stored in fish_variables (universal). To switch variants, install a
|
||||
different theme from themes/:</p>
|
||||
<pre><code>fish_config theme save "Catppuccin Latte"</code></pre>
|
||||
<hr />
|
||||
</body>
|
||||
|
||||
@@ -498,17 +498,64 @@ overhead.</p>
|
||||
or for testing), run:</p>
|
||||
<pre><code>set -Ue __fish_config_first_run_complete</code></pre>
|
||||
<p>Then open a new shell.</p>
|
||||
<p>The plugin list is maintained in fish_plugins at the config root.</p>
|
||||
<h2 data-number="12.1" id="fisher-managed-plugins">Fisher-Managed
|
||||
Plugins</h2>
|
||||
<p>The following plugins are fully managed by Fisher. Their files are
|
||||
installed into the repo directory by Fisher and are listed in
|
||||
<code>.gitignore</code> — do not commit them. Fisher installs and
|
||||
updates them automatically.</p>
|
||||
<pre><code>jorgebucaran/fisher Plugin manager itself
|
||||
catppuccin/fish Catppuccin Mocha color theme
|
||||
PatrickF1/fzf.fish fzf integration for Fish
|
||||
franciscolourenco/done Desktop notification when long commands finish
|
||||
jorgebucaran/autopair.fish Auto-pair brackets and quotes
|
||||
meaningful-ooo/sponge Remove failed commands from history
|
||||
nickeb96/puffer-fish !! / !$ / ./ expansion</code></pre>
|
||||
<p>Run <code>fisher update</code> to update all plugins, or
|
||||
<code>fish-deps update</code> which calls fisher update as its first
|
||||
step.</p>
|
||||
meaningful-ooo/sponge Remove failed commands from history</code></pre>
|
||||
<h2 data-number="12.2" id="sponge-history-filtering">Sponge History
|
||||
Filtering</h2>
|
||||
<p>Sponge removes failed commands from history and, via
|
||||
conf.d/sponge_privacy.fish, also filters privacy-sensitive commands
|
||||
through three layers:</p>
|
||||
<p>Layer 1 — Static patterns (universal, persistent across sessions):
|
||||
Commands matching any of these structural signatures are never
|
||||
recorded:</p>
|
||||
<pre><code>--password / --token / --passphrase / --api-key flags with values
|
||||
Inline env assignments: GITHUB_TOKEN=xxx, MY_API_KEY=abc
|
||||
Fish set with sensitive names: set -gx GITHUB_TOKEN xxx
|
||||
URLs with embedded credentials: https://user:pass@host
|
||||
HTTP Authorization headers: curl -H "Authorization: ..."
|
||||
Basic auth flags: curl -u user:pass
|
||||
sshpass, docker login -p, openssl -passin/-passout</code></pre>
|
||||
<p>Layer 2 — Dynamic secret values (session globals, refreshed each
|
||||
login): On the first prompt, after secrets.fish has loaded, the literal
|
||||
values of all exported variables whose names suggest credentials (TOKEN,
|
||||
PASSWORD, SECRET, API_KEY, etc.) are collected, regex-escaped, and added
|
||||
as a session-scoped overlay. Because globals shadow universals in Fish,
|
||||
the combined list is what sponge sees. Rotating a token takes effect on
|
||||
the next login automatically.</p>
|
||||
<p>Layer 3 — Per-command filter (sponge_filter_secrets): Catches
|
||||
credentials in variables exported after login, such as tokens sourced
|
||||
from a project .env file mid-session.</p>
|
||||
<p>To add your own persistent patterns:</p>
|
||||
<pre><code>set -U -a sponge_regex_patterns 'your-regex-here'</code></pre>
|
||||
<h2 data-number="12.3" id="bundled-plugin-functionality">Bundled Plugin
|
||||
Functionality</h2>
|
||||
<p>The remaining plugin functionality is bundled directly with this
|
||||
config rather than managed through Fisher. The bundled versions include
|
||||
customizations for Fish 4.x compatibility and improved behavior that
|
||||
differ from their upstream releases. Installing them through Fisher
|
||||
would overwrite these customizations.</p>
|
||||
<p>Bundled components and their upstream origins:</p>
|
||||
<pre><code>catppuccin/fish → themes/ + conf.d/theme.fish
|
||||
PatrickF1/fzf.fish → functions/_fzf_*.fish + conf.d/fzf.fish
|
||||
franciscolourenco/done → conf.d/done.fish
|
||||
jorgebucaran/autopair.fish → functions/_autopair_*.fish + conf.d/autopair.fish
|
||||
nickeb96/puffer-fish → functions/_puffer_fish_*.fish + conf.d/puffer.fish</code></pre>
|
||||
<p>Do not run <code>fisher install</code> for these — it will overwrite
|
||||
the customized versions. To update their behavior, edit the relevant
|
||||
bundled files directly.</p>
|
||||
<h2 data-number="12.4" id="fish_plugins-manifest">fish_plugins
|
||||
Manifest</h2>
|
||||
<p>The <code>fish_plugins</code> file at the config root:</p>
|
||||
<pre><code>jorgebucaran/fisher Plugin manager itself
|
||||
meaningful-ooo/sponge Remove failed commands from history</code></pre>
|
||||
<p>To update all Fisher-managed plugins, run <code>fisher update</code>
|
||||
or <code>fish-deps update</code> which calls it as its first step.</p>
|
||||
<hr />
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -493,9 +493,10 @@
|
||||
machine:</p>
|
||||
<pre><code>mv ~/.config/fish ~/.config/fish.bak # back up any existing config
|
||||
git clone https://git.rootiest.dev/rootiest/fish-config.git ~/.config/fish</code></pre>
|
||||
<p>Then open a new Fish shell. Fisher and all plugins install
|
||||
automatically on first launch and the Catppuccin Mocha theme is
|
||||
applied.</p>
|
||||
<p>Then open a new Fish shell. Fisher installs automatically on first
|
||||
launch and the Catppuccin Mocha theme is applied. All other plugin
|
||||
functionality is bundled directly with this config and requires no
|
||||
additional installation.</p>
|
||||
<h2 data-number="13.1" id="return-sentinel">Return Sentinel</h2>
|
||||
<p>config.fish ends with a return sentinel guard. Any lines appended
|
||||
after it by a tool's setup command (starship init fish | source, zoxide
|
||||
|
||||
@@ -524,8 +524,9 @@ Ctrl+Enter Smart execute: runs commands instantly without
|
||||
@@ FZF inline picker. Type @@ anywhere on the command
|
||||
line to open an fzf picker and insert a selection
|
||||
at the cursor position.</code></pre>
|
||||
<h2 data-number="7.1" id="fzf-bindings-from-patrickf1fzffish">FZF
|
||||
Bindings (from PatrickF1/fzf.fish)</h2>
|
||||
<h2 data-number="7.1"
|
||||
id="fzf-bindings-bundled-from-patrickf1fzffish">FZF Bindings (bundled
|
||||
from PatrickF1/fzf.fish)</h2>
|
||||
<pre><code>Ctrl+R Search command history
|
||||
Ctrl+Alt+F Search git-tracked files
|
||||
Ctrl+Alt+L Search git log
|
||||
|
||||
+16
-4
@@ -539,9 +539,10 @@ SETUP</a></li>
|
||||
<li><a href="7-3-key-bindings.html" id="toc-3-key-bindings">3. KEY
|
||||
BINDINGS</a>
|
||||
<ul>
|
||||
<li><a href="7-3-key-bindings.html#fzf-bindings-from-patrickf1fzffish"
|
||||
id="toc-fzf-bindings-from-patrickf1fzffish">FZF Bindings (from
|
||||
PatrickF1/fzf.fish)</a></li>
|
||||
<li><a
|
||||
href="7-3-key-bindings.html#fzf-bindings-bundled-from-patrickf1fzffish"
|
||||
id="toc-fzf-bindings-bundled-from-patrickf1fzffish">FZF Bindings
|
||||
(bundled from PatrickF1/fzf.fish)</a></li>
|
||||
</ul></li>
|
||||
<li><a href="8-4-abbreviations.html" id="toc-4-abbreviations">4.
|
||||
ABBREVIATIONS</a>
|
||||
@@ -830,7 +831,18 @@ Highlighting</a></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
<li><a href="12-8-fisher-plugins.html" id="toc-8-fisher-plugins">8.
|
||||
FISHER PLUGINS</a></li>
|
||||
FISHER PLUGINS</a>
|
||||
<ul>
|
||||
<li><a href="12-8-fisher-plugins.html#fisher-managed-plugins"
|
||||
id="toc-fisher-managed-plugins">Fisher-Managed Plugins</a></li>
|
||||
<li><a href="12-8-fisher-plugins.html#sponge-history-filtering"
|
||||
id="toc-sponge-history-filtering">Sponge History Filtering</a></li>
|
||||
<li><a href="12-8-fisher-plugins.html#bundled-plugin-functionality"
|
||||
id="toc-bundled-plugin-functionality">Bundled Plugin
|
||||
Functionality</a></li>
|
||||
<li><a href="12-8-fisher-plugins.html#fish_plugins-manifest"
|
||||
id="toc-fish_plugins-manifest">fish_plugins Manifest</a></li>
|
||||
</ul></li>
|
||||
<li><a href="13-9-installation.html" id="toc-9-installation">9.
|
||||
INSTALLATION</a>
|
||||
<ul>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -40,7 +40,7 @@ are active in Insert, Normal, and Visual modes unless noted.
|
||||
line to open an fzf picker and insert a selection
|
||||
at the cursor position.
|
||||
|
||||
## FZF Bindings (from PatrickF1/fzf.fish)
|
||||
## FZF Bindings (bundled from PatrickF1/fzf.fish)
|
||||
|
||||
Ctrl+R Search command history
|
||||
Ctrl+Alt+F Search git-tracked files
|
||||
|
||||
@@ -64,9 +64,9 @@ To customize, override FZF_DEFAULT_OPTS in local.fish.
|
||||
|
||||
### Catppuccin Mocha Syntax Highlighting
|
||||
|
||||
The catppuccin/fish plugin applies syntax highlight colors on first run.
|
||||
Colors are stored in fish_variables (universal). To switch variants, install
|
||||
a different theme from the themes/ directory:
|
||||
The Catppuccin Mocha theme ships with this config in themes/ and is applied
|
||||
on first run via `conf.d/first_run.fish`. Colors are stored in fish_variables
|
||||
(universal). To switch variants, install a different theme from themes/:
|
||||
|
||||
fish_config theme save "Catppuccin Latte"
|
||||
|
||||
|
||||
@@ -16,17 +16,73 @@ testing), run:
|
||||
|
||||
Then open a new shell.
|
||||
|
||||
The plugin list is maintained in fish_plugins at the config root.
|
||||
## Fisher-Managed Plugins
|
||||
|
||||
The following plugins are fully managed by Fisher. Their files are installed
|
||||
into the repo directory by Fisher and are listed in `.gitignore` — do not
|
||||
commit them. Fisher installs and updates them automatically.
|
||||
|
||||
jorgebucaran/fisher Plugin manager itself
|
||||
catppuccin/fish Catppuccin Mocha color theme
|
||||
PatrickF1/fzf.fish fzf integration for Fish
|
||||
franciscolourenco/done Desktop notification when long commands finish
|
||||
jorgebucaran/autopair.fish Auto-pair brackets and quotes
|
||||
meaningful-ooo/sponge Remove failed commands from history
|
||||
nickeb96/puffer-fish !! / !$ / ./ expansion
|
||||
|
||||
Run `fisher update` to update all plugins, or `fish-deps update` which
|
||||
calls fisher update as its first step.
|
||||
## Sponge History Filtering
|
||||
|
||||
Sponge removes failed commands from history and, via conf.d/sponge_privacy.fish,
|
||||
also filters privacy-sensitive commands through three layers:
|
||||
|
||||
Layer 1 — Static patterns (universal, persistent across sessions):
|
||||
Commands matching any of these structural signatures are never recorded:
|
||||
|
||||
--password / --token / --passphrase / --api-key flags with values
|
||||
Inline env assignments: GITHUB_TOKEN=xxx, MY_API_KEY=abc
|
||||
Fish set with sensitive names: set -gx GITHUB_TOKEN xxx
|
||||
URLs with embedded credentials: https://user:pass@host
|
||||
HTTP Authorization headers: curl -H "Authorization: ..."
|
||||
Basic auth flags: curl -u user:pass
|
||||
sshpass, docker login -p, openssl -passin/-passout
|
||||
|
||||
Layer 2 — Dynamic secret values (session globals, refreshed each login):
|
||||
On the first prompt, after secrets.fish has loaded, the literal values of
|
||||
all exported variables whose names suggest credentials (TOKEN, PASSWORD,
|
||||
SECRET, API_KEY, etc.) are collected, regex-escaped, and added as a
|
||||
session-scoped overlay. Because globals shadow universals in Fish, the
|
||||
combined list is what sponge sees. Rotating a token takes effect on the
|
||||
next login automatically.
|
||||
|
||||
Layer 3 — Per-command filter (sponge_filter_secrets):
|
||||
Catches credentials in variables exported after login, such as tokens
|
||||
sourced from a project .env file mid-session.
|
||||
|
||||
To add your own persistent patterns:
|
||||
|
||||
set -U -a sponge_regex_patterns 'your-regex-here'
|
||||
|
||||
## Bundled Plugin Functionality
|
||||
|
||||
The remaining plugin functionality is bundled directly with this config rather
|
||||
than managed through Fisher. The bundled versions include customizations for
|
||||
Fish 4.x compatibility and improved behavior that differ from their upstream
|
||||
releases. Installing them through Fisher would overwrite these customizations.
|
||||
|
||||
Bundled components and their upstream origins:
|
||||
|
||||
catppuccin/fish → themes/ + conf.d/theme.fish
|
||||
PatrickF1/fzf.fish → functions/_fzf_*.fish + conf.d/fzf.fish
|
||||
franciscolourenco/done → conf.d/done.fish
|
||||
jorgebucaran/autopair.fish → functions/_autopair_*.fish + conf.d/autopair.fish
|
||||
nickeb96/puffer-fish → functions/_puffer_fish_*.fish + conf.d/puffer.fish
|
||||
|
||||
Do not run `fisher install` for these — it will overwrite the customized
|
||||
versions. To update their behavior, edit the relevant bundled files directly.
|
||||
|
||||
## fish_plugins Manifest
|
||||
|
||||
The `fish_plugins` file at the config root:
|
||||
|
||||
jorgebucaran/fisher Plugin manager itself
|
||||
meaningful-ooo/sponge Remove failed commands from history
|
||||
|
||||
To update all Fisher-managed plugins, run `fisher update` or `fish-deps
|
||||
update` which calls it as its first step.
|
||||
|
||||
---
|
||||
|
||||
@@ -9,8 +9,9 @@ This configuration is managed as a git repository. To deploy on a new machine:
|
||||
mv ~/.config/fish ~/.config/fish.bak # back up any existing config
|
||||
git clone https://git.rootiest.dev/rootiest/fish-config.git ~/.config/fish
|
||||
|
||||
Then open a new Fish shell. Fisher and all plugins install automatically on
|
||||
first launch and the Catppuccin Mocha theme is applied.
|
||||
Then open a new Fish shell. Fisher installs automatically on first launch
|
||||
and the Catppuccin Mocha theme is applied. All other plugin functionality is
|
||||
bundled directly with this config and requires no additional installation.
|
||||
|
||||
## Return Sentinel
|
||||
|
||||
|
||||
Reference in New Issue
Block a user