chore(docs): regenerate manual and man page
This commit is contained in:
+41
-16
@@ -4284,15 +4284,21 @@ Their files are installed into the repo directory by Fisher and are
|
|||||||
listed in \f[V].gitignore\f[R] \[em] do not commit them.
|
listed in \f[V].gitignore\f[R] \[em] do not commit them.
|
||||||
Fisher installs and updates them automatically.
|
Fisher installs and updates them automatically.
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[V]jorgebucaran/fisher\f[R] \[em] Plugin manager itself
|
\f[V]jorgebucaran/fisher\f[R] (https://github.com/jorgebucaran/fisher)
|
||||||
|
\[em] Plugin manager itself
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[V]meaningful-ooo/sponge\f[R] \[em] Remove failed commands from
|
\f[V]meaningful-ooo/sponge\f[R] (https://github.com/meaningful-ooo/sponge)
|
||||||
history
|
\[em] Remove failed commands from history
|
||||||
.SS Sponge History Filtering
|
.SS Sponge History Filtering
|
||||||
.PP
|
.PP
|
||||||
Sponge removes failed commands from history and, via
|
Sponge removes failed commands from history and, via
|
||||||
conf.d/sponge_privacy.fish, also filters privacy-sensitive commands
|
conf.d/sponge_privacy.fish, also filters privacy-sensitive commands
|
||||||
through three layers:
|
through three layers.
|
||||||
|
Detection is heuristic \[em] pattern- and variable-name-based \[em] so
|
||||||
|
this reduces the risk of a credential landing in persistent history; it
|
||||||
|
is not a guarantee that no secret can ever reach it, and it is not a
|
||||||
|
substitute for rotating a credential that gets typed in plaintext.
|
||||||
|
Treat it as a safety net, not a vault.
|
||||||
.PP
|
.PP
|
||||||
Layer 1 \[em] Static patterns (universal, persistent across sessions):
|
Layer 1 \[em] Static patterns (universal, persistent across sessions):
|
||||||
Commands matching any of these structural signatures are never recorded:
|
Commands matching any of these structural signatures are never recorded:
|
||||||
@@ -4328,6 +4334,23 @@ Layer 3 \[em] Per-command filter (sponge_filter_secrets): Catches
|
|||||||
credentials in variables exported after login, such as tokens sourced
|
credentials in variables exported after login, such as tokens sourced
|
||||||
from a project .env file mid-session.
|
from a project .env file mid-session.
|
||||||
.PP
|
.PP
|
||||||
|
A match is actively deleted from history, not stored and redacted.
|
||||||
|
Sponge queues a matched command on \f[V]fish_postexec\f[R] and purges
|
||||||
|
anything past \f[V]sponge_delay\f[R] entries on the very next
|
||||||
|
\f[V]fish_prompt\f[R], immediately forcing a \f[V]history save\f[R].
|
||||||
|
With this config\[cq]s (upstream) defaults, that means a matched command
|
||||||
|
is gone from disk within about one prompt cycle \[em] it is not left
|
||||||
|
sitting in persistent history for the rest of the session.
|
||||||
|
.PP
|
||||||
|
This timing depends on \f[V]sponge_purge_only_on_exit\f[R] staying
|
||||||
|
\f[V]false\f[R], which is sponge\[cq]s own default and is not overridden
|
||||||
|
here.
|
||||||
|
Turning it on defers all purging to the \f[V]fish_exit\f[R] event
|
||||||
|
instead of the next prompt \[em] and because \f[V]fish_exit\f[R] does
|
||||||
|
not fire on a killed or crashed session, a matched command purged only
|
||||||
|
on exit can survive indefinitely if the shell never exits cleanly.
|
||||||
|
Leave this setting off.
|
||||||
|
.PP
|
||||||
To add your own persistent patterns:
|
To add your own persistent patterns:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@@ -4365,19 +4388,20 @@ Installing them through Fisher would overwrite these customizations.
|
|||||||
.PP
|
.PP
|
||||||
Bundled components and their upstream origins:
|
Bundled components and their upstream origins:
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[V]catppuccin/fish\f[R] → \f[V]themes/\f[R] +
|
\f[V]catppuccin/fish\f[R] (https://github.com/catppuccin/fish) →
|
||||||
\f[V]conf.d/theme.fish\f[R]
|
\f[V]themes/\f[R] + \f[V]conf.d/theme.fish\f[R]
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[V]PatrickF1/fzf.fish\f[R] → \f[V]functions/_fzf_*.fish\f[R] +
|
\f[V]PatrickF1/fzf.fish\f[R] (https://github.com/PatrickF1/fzf.fish) →
|
||||||
\f[V]conf.d/fzf.fish\f[R]
|
\f[V]functions/_fzf_*.fish\f[R] + \f[V]conf.d/fzf.fish\f[R]
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[V]franciscolourenco/done\f[R] → \f[V]conf.d/done.fish\f[R]
|
\f[V]franciscolourenco/done\f[R] (https://github.com/franciscolourenco/done)
|
||||||
|
→ \f[V]conf.d/done.fish\f[R]
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[V]jorgebucaran/autopair.fish\f[R] →
|
\f[V]jorgebucaran/autopair.fish\f[R] (https://github.com/jorgebucaran/autopair.fish)
|
||||||
\f[V]functions/_autopair_*.fish\f[R] + \f[V]conf.d/autopair.fish\f[R]
|
→ \f[V]functions/_autopair_*.fish\f[R] + \f[V]conf.d/autopair.fish\f[R]
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[V]nickeb96/puffer-fish\f[R] → \f[V]functions/_puffer_fish_*.fish\f[R]
|
\f[V]nickeb96/puffer-fish\f[R] (https://github.com/nickeb96/puffer-fish)
|
||||||
+ \f[V]conf.d/puffer.fish\f[R]
|
→ \f[V]functions/_puffer_fish_*.fish\f[R] + \f[V]conf.d/puffer.fish\f[R]
|
||||||
.PP
|
.PP
|
||||||
Do not run \f[V]fisher install\f[R] for these \[em] it will overwrite
|
Do not run \f[V]fisher install\f[R] for these \[em] it will overwrite
|
||||||
the customized versions.
|
the customized versions.
|
||||||
@@ -4386,10 +4410,11 @@ To update their behavior, edit the relevant bundled files directly.
|
|||||||
.PP
|
.PP
|
||||||
The \f[V]fish_plugins\f[R] file at the config root:
|
The \f[V]fish_plugins\f[R] file at the config root:
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[V]jorgebucaran/fisher\f[R] \[em] Plugin manager itself
|
\f[V]jorgebucaran/fisher\f[R] (https://github.com/jorgebucaran/fisher)
|
||||||
|
\[em] Plugin manager itself
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
\f[V]meaningful-ooo/sponge\f[R] \[em] Remove failed commands from
|
\f[V]meaningful-ooo/sponge\f[R] (https://github.com/meaningful-ooo/sponge)
|
||||||
history
|
\[em] Remove failed commands from history
|
||||||
.PP
|
.PP
|
||||||
To update all Fisher-managed plugins, run \f[V]fisher update\f[R] or
|
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.
|
\f[V]fish-deps update\f[R] which calls it as its first step.
|
||||||
|
|||||||
Reference in New Issue
Block a user