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

Merge pull request 'docs(manual): format plugins and installation pages' (#100) from docs-format-plugins-installation into main
Generate documentation / build-docs (push) Successful in 3m32s
Details

Browse Source 
Reviewed-on: #100
This commit was merged in pull request #100.
This commit is contained in:
rootiest
2026-08-06 20:29:18 +00:00
parent 7c99b475e3 4ff120cc5d
commit dfdc1063ba
3 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/fish-config.md
+23 -23
View File
@@ -3255,8 +3255,8 @@ 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 into the repo directory by Fisher and are listed in `.gitignore` — do not
commit them. Fisher installs and updates them automatically. commit them. Fisher installs and updates them automatically.
jorgebucaran/fisher Plugin manager itself - `jorgebucaran/fisher` — Plugin manager itself
meaningful-ooo/sponge Remove failed commands from history - `meaningful-ooo/sponge` — Remove failed commands from history
## Sponge History Filtering ## Sponge History Filtering
@@ -3266,13 +3266,13 @@ also filters privacy-sensitive commands through three layers:
Layer 1 — Static patterns (universal, persistent across sessions): Layer 1 — 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:
--password / --token / --passphrase / --api-key flags with values - `--password` / `--token` / `--passphrase` / `--api-key` flags with values
Inline env assignments: GITHUB_TOKEN=xxx, MY_API_KEY=abc - Inline env assignments: `GITHUB_TOKEN=xxx`, `MY_API_KEY=abc`
Fish set with sensitive names: set -gx GITHUB_TOKEN xxx - Fish set with sensitive names: `set -gx GITHUB_TOKEN xxx`
URLs with embedded credentials: https://user:pass@host - URLs with embedded credentials: `https://user:pass@host`
HTTP Authorization headers: curl -H "Authorization: ..." - HTTP Authorization headers: `curl -H "Authorization: ..."`
Basic auth flags: curl -u user:pass - Basic auth flags: `curl -u user:pass`
sshpass, docker login -p, openssl -passin/-passout - `sshpass`, `docker login -p`, `openssl -passin/-passout`
Layer 2 — Dynamic secret values (session globals, refreshed each login): Layer 2 — Dynamic secret values (session globals, refreshed each login):
On the first prompt, after secrets.fish has loaded, the literal values of On the first prompt, after secrets.fish has loaded, the literal values of
@@ -3313,11 +3313,11 @@ releases. Installing them through Fisher would overwrite these customizations.
Bundled components and their upstream origins: Bundled components and their upstream origins:
catppuccin/fish → themes/ + conf.d/theme.fish - `catppuccin/fish` → `themes/` + `conf.d/theme.fish`
PatrickF1/fzf.fish → functions/_fzf_*.fish + conf.d/fzf.fish - `PatrickF1/fzf.fish` → `functions/_fzf_*.fish` + `conf.d/fzf.fish`
franciscolourenco/done → conf.d/done.fish - `franciscolourenco/done` → `conf.d/done.fish`
jorgebucaran/autopair.fish → functions/_autopair_*.fish + conf.d/autopair.fish - `jorgebucaran/autopair.fish` → `functions/_autopair_*.fish` + `conf.d/autopair.fish`
nickeb96/puffer-fish → functions/_puffer_fish_*.fish + conf.d/puffer.fish - `nickeb96/puffer-fish` → `functions/_puffer_fish_*.fish` + `conf.d/puffer.fish`
Do not run `fisher install` for these — it will overwrite the customized Do not run `fisher install` for these — it will overwrite the customized
versions. To update their behavior, edit the relevant bundled files directly. versions. To update their behavior, edit the relevant bundled files directly.
@@ -3326,8 +3326,8 @@ versions. To update their behavior, edit the relevant bundled files directly.
The `fish_plugins` file at the config root: The `fish_plugins` file at the config root:
jorgebucaran/fisher Plugin manager itself - `jorgebucaran/fisher` — Plugin manager itself
meaningful-ooo/sponge Remove failed commands from history - `meaningful-ooo/sponge` — Remove failed commands from history
To update all Fisher-managed plugins, run `fisher update` or `fish-deps To update all Fisher-managed plugins, run `fisher update` or `fish-deps
update` which calls it as its first step. update` which calls it as its first step.
@@ -3347,9 +3347,9 @@ bundled directly with this config and requires no additional installation.
## Return Sentinel ## Return Sentinel
config.fish ends with a return sentinel guard. Any lines appended after it by `config.fish` ends with a return sentinel guard. Any lines appended after it by
a tool's setup command (starship init fish | source, zoxide init fish | source, a tool's setup command (`starship init fish | source`, `zoxide init fish | source`,
etc.) will have no effect. All integrations are managed via conf.d/ files. etc.) will have no effect. All integrations are managed via `conf.d/` files.
If a new tool's shell integration appears to do nothing, check whether its If a new tool's shell integration appears to do nothing, check whether its
setup command appended an init line below the sentinel and create a dedicated setup command appended an init line below the sentinel and create a dedicated
@@ -3360,11 +3360,11 @@ setup command appended an init line below the sentinel and create a dedicated
Pull the latest changes from the upstream repository without needing a Pull the latest changes from the upstream repository without needing a
configured git remote: configured git remote:
config-update Fetch and apply the latest commits from upstream - `config-update` — Fetch and apply the latest commits from upstream
config-update --dry-run Preview available changes without applying them - `config-update --dry-run` — Preview available changes without applying them
config-update --force Stash local changes, pull, then restore the stash - `config-update --force` — Stash local changes, pull, then restore the stash
All git output is suppressed. Run exec fish after a successful update to reload. All git output is suppressed. Run `exec fish` after a successful update to reload.
--- ---
docs/manual/09-fisher-plugins.md
+16 -16
View File
@@ -27,8 +27,8 @@ 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 into the repo directory by Fisher and are listed in `.gitignore` — do not
commit them. Fisher installs and updates them automatically. commit them. Fisher installs and updates them automatically.
jorgebucaran/fisher Plugin manager itself - `jorgebucaran/fisher` — Plugin manager itself
meaningful-ooo/sponge Remove failed commands from history - `meaningful-ooo/sponge` — Remove failed commands from history
## Sponge History Filtering ## Sponge History Filtering
@@ -38,13 +38,13 @@ also filters privacy-sensitive commands through three layers:
Layer 1 — Static patterns (universal, persistent across sessions): Layer 1 — 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:
--password / --token / --passphrase / --api-key flags with values - `--password` / `--token` / `--passphrase` / `--api-key` flags with values
Inline env assignments: GITHUB_TOKEN=xxx, MY_API_KEY=abc - Inline env assignments: `GITHUB_TOKEN=xxx`, `MY_API_KEY=abc`
Fish set with sensitive names: set -gx GITHUB_TOKEN xxx - Fish set with sensitive names: `set -gx GITHUB_TOKEN xxx`
URLs with embedded credentials: https://user:pass@host - URLs with embedded credentials: `https://user:pass@host`
HTTP Authorization headers: curl -H "Authorization: ..." - HTTP Authorization headers: `curl -H "Authorization: ..."`
Basic auth flags: curl -u user:pass - Basic auth flags: `curl -u user:pass`
sshpass, docker login -p, openssl -passin/-passout - `sshpass`, `docker login -p`, `openssl -passin/-passout`
Layer 2 — Dynamic secret values (session globals, refreshed each login): Layer 2 — Dynamic secret values (session globals, refreshed each login):
On the first prompt, after secrets.fish has loaded, the literal values of On the first prompt, after secrets.fish has loaded, the literal values of
@@ -85,11 +85,11 @@ releases. Installing them through Fisher would overwrite these customizations.
Bundled components and their upstream origins: Bundled components and their upstream origins:
catppuccin/fish → themes/ + conf.d/theme.fish - `catppuccin/fish` → `themes/` + `conf.d/theme.fish`
PatrickF1/fzf.fish → functions/_fzf_*.fish + conf.d/fzf.fish - `PatrickF1/fzf.fish` → `functions/_fzf_*.fish` + `conf.d/fzf.fish`
franciscolourenco/done → conf.d/done.fish - `franciscolourenco/done` → `conf.d/done.fish`
jorgebucaran/autopair.fish → functions/_autopair_*.fish + conf.d/autopair.fish - `jorgebucaran/autopair.fish` → `functions/_autopair_*.fish` + `conf.d/autopair.fish`
nickeb96/puffer-fish → functions/_puffer_fish_*.fish + conf.d/puffer.fish - `nickeb96/puffer-fish` → `functions/_puffer_fish_*.fish` + `conf.d/puffer.fish`
Do not run `fisher install` for these — it will overwrite the customized Do not run `fisher install` for these — it will overwrite the customized
versions. To update their behavior, edit the relevant bundled files directly. versions. To update their behavior, edit the relevant bundled files directly.
@@ -98,8 +98,8 @@ versions. To update their behavior, edit the relevant bundled files directly.
The `fish_plugins` file at the config root: The `fish_plugins` file at the config root:
jorgebucaran/fisher Plugin manager itself - `jorgebucaran/fisher` — Plugin manager itself
meaningful-ooo/sponge Remove failed commands from history - `meaningful-ooo/sponge` — Remove failed commands from history
To update all Fisher-managed plugins, run `fisher update` or `fish-deps To update all Fisher-managed plugins, run `fisher update` or `fish-deps
update` which calls it as its first step. update` which calls it as its first step.
docs/manual/10-installation.md
+7 -7
View File
@@ -19,9 +19,9 @@ bundled directly with this config and requires no additional installation.
## Return Sentinel ## Return Sentinel
config.fish ends with a return sentinel guard. Any lines appended after it by `config.fish` ends with a return sentinel guard. Any lines appended after it by
a tool's setup command (starship init fish | source, zoxide init fish | source, a tool's setup command (`starship init fish | source`, `zoxide init fish | source`,
etc.) will have no effect. All integrations are managed via conf.d/ files. etc.) will have no effect. All integrations are managed via `conf.d/` files.
If a new tool's shell integration appears to do nothing, check whether its If a new tool's shell integration appears to do nothing, check whether its
setup command appended an init line below the sentinel and create a dedicated setup command appended an init line below the sentinel and create a dedicated
@@ -32,10 +32,10 @@ setup command appended an init line below the sentinel and create a dedicated
Pull the latest changes from the upstream repository without needing a Pull the latest changes from the upstream repository without needing a
configured git remote: configured git remote:
config-update Fetch and apply the latest commits from upstream - `config-update` — Fetch and apply the latest commits from upstream
config-update --dry-run Preview available changes without applying them - `config-update --dry-run` — Preview available changes without applying them
config-update --force Stash local changes, pull, then restore the stash - `config-update --force` — Stash local changes, pull, then restore the stash
All git output is suppressed. Run exec fish after a successful update to reload. All git output is suppressed. Run `exec fish` after a successful update to reload.
--- ---