Skip to content

volta completions

volta completions 命令将为您的 shell 生成命令补全信息。它具有以下语法:

bash
生成 Volta 补全

默认情况下,将为您当前 shell 的值生成补全,
 `SHELL` 的值。如果您设置了 `<shell>` 选项,将为该 shell 生成补全。

如果您指定一个目录,补全将被写入那里的文件;
否则,它们将被写入 `stdout`

用法:
    volta completions [FLAGS] [OPTIONS] <shell>

标志:
    -f, --force      覆盖现有文件(如果有)。
        --verbose    启用详细诊断
        --quiet      防止不必要的输出
    -h, --help       打印帮助信息

选项:
    -o, --output <out_file>    写入生成的补全的文件

参数:
    <shell>    为其生成补全的 Shell [可能的值: zsh, bash, fish, powershell, elvish]

示例

为您当前的 Shell 生成补全

bash
# 生成补全并打印到 stdout
volta completions

为特定 Shell 生成补全

bash
# 生成 Bash 补全
volta completions bash

# 生成 Zsh 补全
volta completions zsh

# 生成 Fish 补全
volta completions fish

# 生成 PowerShell 补全
volta completions powershell

# 生成 Elvish 补全
volta completions elvish

将补全输出到文件

bash
# 将 bash 补全保存到文件
volta completions bash -o volta.bash

# 将 zsh 补全保存到文件并强制覆盖
volta completions zsh -o _volta -f

安装补全

生成补全后,您需要为您的 shell 安装它们。以下是不同 shell 的常见安装方法:

Bash

bash
# 生成并保存 bash 补全
volta completions bash > ~/.volta-completions.bash

# 添加到您的 ~/.bashrc
echo 'source ~/.volta-completions.bash' >> ~/.bashrc

# 将更改应用到当前会话
source ~/.bashrc

Zsh

bash
# 如果不存在,创建补全目录
mkdir -p ~/.zsh/completions

# 生成并保存 zsh 补全
volta completions zsh > ~/.zsh/completions/_volta

# 添加到您的 ~/.zshrc(如果尚未包含)
echo 'fpath=(~/.zsh/completions $fpath)' >> ~/.zshrc
echo 'autoload -Uz compinit && compinit' >> ~/.zshrc

# 将更改应用到当前会话
source ~/.zshrc

Fish

bash
# 生成并保存 fish 补全
volta completions fish > ~/.config/fish/completions/volta.fish

# Fish 将自动从此目录加载补全

PowerShell

powershell
# 生成 PowerShell 补全
volta completions powershell > volta-completions.ps1

# 添加到您的 PowerShell 配置文件
echo '. /path/to/volta-completions.ps1' >> $PROFILE

# 将更改应用到当前会话
. $PROFILE

使用场景

Shell 补全通过以下方式使 Volta 的使用更加高效:

  1. 当您输入 volta 时建议可用的子命令
  2. volta installvolta uninstall 等命令提供工具名称
  3. 补全标志和选项
  4. 通过减少输入和错误来提高生产力