feat: support dynamic fish completion by Maks1mS · Pull Request #2270 · urfave/cli

Maks1mS · 2026-02-28T15:40:06Z

What type of PR is this?

(REQUIRED)

feature

What this PR does / why we need it:

(REQUIRED)

The previous fish shell completion implementation generated completions statically at install time by embedding all subcommands and flags directly into the completion script. The primary motivation for this change is multilingual support: static completions make it impossible to provide localized descriptions, since the language cannot be determined until runtime.

I understand this is a significant change and may introduce compatibility concerns. I'm open to discussing the best approach - for example, adding a boolean field to opt into the new dynamic completion behavior, or any other alternative you think fits better.

Which issue(s) this PR fixes:

(REQUIRED)

Replaces #2144

Special notes for your reviewer:

(fill-in or delete this section)

I suspect that all existing zsh problems will become relevant for fish when merging this PR, which means it will be a possible regression.
Maybe it's worth making the new behavior optional to gather feedback or something like that?

Testing

(fill-in or delete this section)

I added unit tests similar to zsh, but it seems this requires manual testing. In my scenarios it works well (on par with zsh).

Release Notes

(REQUIRED)

Fish shell completions are now generated dynamically at runtime (similar to other shells)

dearchap

@Maks1mS thank you for the PR. Appreciate it.

This PR contains the following updates: | Package | Type | Update | Change | OpenSSF | |---|---|---|---|---| | [github.com/urfave/cli/v3](https://github.com/urfave/cli) | require | minor | `v3.6.2` → `v3.7.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/urfave/cli/badge)](https://securityscorecards.dev/viewer/?uri=github.com/urfave/cli) | --- > ⚠️ **Warning** > > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>urfave/cli (github.com/urfave/cli/v3)</summary> ### [`v3.7.0`](https://github.com/urfave/cli/releases/tag/v3.7.0) [Compare Source](urfave/cli@v3.6.2...v3.7.0) #### What's Changed - Fix: use the correct type name in the tracef message by [@icholy](https://github.com/icholy) in [#2251](urfave/cli#2251) - chore(deps): bump mkdocs-git-revision-date-localized-plugin from 1.5.0 to 1.5.1 in the python-packages group by [@dependabot](https://github.com/dependabot)\[bot] in [#2252](urfave/cli#2252) - Fix:(issue\_2254) Fix incorrect handling of arg after short option token by [@dearchap](https://github.com/dearchap) in [#2255](urfave/cli#2255) - feat: ShellComplete for fish by [@marcusramberg](https://github.com/marcusramberg) in [#2256](urfave/cli#2256) - Fix: propagate MutuallyExclusiveFlags persistent flags to subcommands by [@siutsin](https://github.com/siutsin) in [#2266](urfave/cli#2266) - feat: support dynamic fish completion by [@Maks1mS](https://github.com/Maks1mS) in [#2270](urfave/cli#2270) - fix(help): show GLOBAL OPTIONS for leaf subcommands when HideHelpCommand is true by [@TimSoethout](https://github.com/TimSoethout) in [#2269](urfave/cli#2269) #### New Contributors - [@marcusramberg](https://github.com/marcusramberg) made their first contribution in [#2256](urfave/cli#2256) - [@siutsin](https://github.com/siutsin) made their first contribution in [#2266](urfave/cli#2266) - [@TimSoethout](https://github.com/TimSoethout) made their first contribution in [#2269](urfave/cli#2269) **Full Changelog**: <urfave/cli@v3.6.2...v3.7.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At 12:00 AM through 04:59 AM and 10:00 PM through 11:59 PM, Monday through Friday ( * 0-4,22-23 * * 1-5 ), Only on Sunday and Saturday ( * * * * 0,6 ) (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://altlinux.space/stapler/stplr/pulls/340 Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>

marcusramberg · 2026-03-05T14:35:46Z

Kinda seems like this broke fish completion for me:

❯ ./result/bin/hei completion fish|source
- (line 3): Unsupported use of '='. In fish, please use 'set string hei'.
function __%!_(string=hei)perform_completion
               ^~~~~~~~~^
from sourcing file -
source: Error while reading file “<stdin>”

TimSoethout · 2026-03-19T09:49:22Z

I have the same issue as @marcusramberg :

~/.local/share/fish/vendor_completions.d/toolname.fish (line 3): Unsupported use of '='. In fish, please use 'set string toolname'.
function __%!_(string=toolname)perform_completion
               ^~~~~~~~~~~~^
from sourcing file ~/.local/share/fish/vendor_completions.d/toolname.fish
	called on line 1 of file ~/.config/fish/conf.d/toolname-forwarding.fish
from sourcing file ~/.config/fish/conf.d/toolname-forwarding.fish
	called on line 223 of file embedded:config.fish
from sourcing file embedded:config.fish
	called during startup
source: Error while reading file '/Users/de13lb/.local/share/fish/vendor_completions.d/toolname.fish'

Opened an issue: #2285

feat: support dynamic fish completion

08fd570

Maks1mS requested a review from a team as a code owner February 28, 2026 15:40

dearchap approved these changes Mar 1, 2026

View reviewed changes

dearchap merged commit 600026f into urfave:main Mar 1, 2026
9 checks passed

Maks1mS deleted the feat/dynamic-fish-completion branch March 2, 2026 07:17

TimSoethout mentioned this pull request Mar 19, 2026

Dynamic fish completions breaks fish completions #2285

Closed

suzuki-shunsuke mentioned this pull request Mar 19, 2026

Fish completion script is malformed aquaproj/aqua#4655

Open

TimSoethout mentioned this pull request Mar 19, 2026

Fix:(issue_2285): correct function and variable naming in fish completion script #2286

Merged

Navigation Menu

Repository navigation

feat: support dynamic fish completion - #2270

feat: support dynamic fish completion#2270
dearchap merged 1 commit into
urfave:mainfrom
Maks1mS:feat/dynamic-fish-completion

Maks1mS commented Feb 28, 2026

Uh oh!

dearchap left a comment

Uh oh!

Uh oh!

marcusramberg commented Mar 5, 2026 •

edited

Loading

Uh oh!

TimSoethout commented Mar 19, 2026 •

edited

Loading

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Maks1mS commented Feb 28, 2026

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Testing

Release Notes

Uh oh!

dearchap left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

marcusramberg commented Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TimSoethout commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

marcusramberg commented Mar 5, 2026 •

edited

Loading

TimSoethout commented Mar 19, 2026 •

edited

Loading