Generate shell completion for uvx

[bluss]

Summary

Generate shell completion for uvx.

Create a uvx toplevel command just for completion by combining uv tool uvx (hidden alias for uv tool run) with global arguments. This explicit combination is needed otherwise global arguments are missing (if they are missing, clap debug assertions fail when uv tool run arguments refer to global arguments in directives like conflicts with).

The command uv generate-shell-completion now generates completion for both uv and uvx in the same output.

Fixes #7258

Test Plan

• Tested using bash using eval "$(cargo run --bin uv generate-shell-completion bash)"

[bluss]

Some issues that need to be resolved

• I removed global deprecated --isolated, otherwise it conflicts with uvx --isolated and this trips a runtime error. This part of the PR is (as is evident) just a placeholder, needs to be resolved
  • Not removed anymore. Just skipping the conflicting thing when we do shell completion.
• Currently the method is uvx subcommand + TopLevelArgs. I think the better layer order would be TopLevelArgs + uvx subcommand. But I don't know clap enough to know if this makes a difference.
  • Resolved? because uvx + TopLevelArgs layering reproduces current uv tool run argument sort order
• Do all shells support combining uv and uvx completions in the same stream or file? Bash and fish (see generate-shell-completion: generate uvx shell completions for the fish shell #7323) support this.

[bluss]

Normal way to install completion for a command in bash:

BASH_COMPLETION_DIR="$HOME/.local/share/bash-completion/completions"
mkdir -p "$BASH_COMPLETION_DIR"
uv generate-shell-completion bash > "$BASH_COMPLETION_DIR"/uv

bash lazy loads completion for the command uv from a file called uv. To support lazy loading for uvx, another file for uvx is needed. The recommended solution is to use a symlink from uvx -> uv

ln -sf "$BASH_COMPLETION_DIR"/uv "$BASH_COMPLETION_DIR"/uvx

The documented way to install shell completion by uv is to use this, which will continue to work unchanged:

eval "$(uv generate-shell-completion bash)"

[bluss]

Not WIP anymore because it's in shipshape - if reviewers agree, of course.

I had previously removed global --isolated because it tripped a debug assertion when conflicting with a different argument with the same name. But that change is now reverted in the PR, I just skip that arg when creating the synthetic Uvx Command for shell completion.

[charliermarsh]

This looks great, thank you.

[ilyagr]

Thank you!

[ilyagr]

I'm not the author, but my understanding is that uv generate-shell-completion bash currently generates the completions for both uv and uvx. I'm not sure that uvx generate-shell-completion bash will work at all.

If my understanding is correct, these docs are misleading, and there isn't really need for docs. The existing instructions will cause completion to work for both uv and uvx.

It wouldn't be hard to modify this code to generate the completions separately, e.g. something like uv generate-shell-completion --uvx-only bash. Update: (But I don't think there's a real need for this until somebody asks for it)

[charliermarsh]

You’re right, I misread the instructions in the summary. Will revert in the morning (or anyone is welcome to PR).

[bluss]

We could expand the docs with the statement that uv and uvx completions are included in the same output.

Not sure if it's worth providing further hints, like if you use a per command file for completions, duplicate the output in both files or symlink uvx -> uv. Could be discussed in future docs changes.