zsh-completions 技术文档

1. 安装指南

使用包管理器安装

以下是在不同操作系统中使用包管理器安装 zsh-completions 的方法：

• Debian / Ubuntu: 使用 zsh-completions OBS 存储库
• Fedora / CentOS / RHEL / Scientific Linux: 使用 zsh-completions OBS 存储库
• OpenSUSE / SLE: 使用 zsh-completions OBS 存储库
• Arch Linux / Manjaro / Antergos / Hyperbola: 使用 zsh-completions, zsh-completions-git
• Gentoo / Funtoo: 使用 app-shells/zsh-completions
• NixOS: 使用 zsh-completions
• Void Linux: 使用 zsh-completions
• Slackware: 使用 Slackbuilds
• macOS: 使用 homebrew, MacPorts
• NetBSD: 使用 pkgsrc
• FreeBSD: 使用 shells/zsh-completions

使用 zsh 框架安装

使用 antigen

在 ~/.zshrc 文件中添加 antigen bundle zsh-users/zsh-completions。

使用 oh-my-zsh

• 将仓库克隆到 oh-my-zsh 目录中：

  git clone https://github.com/zsh-users/zsh-completions ${ZSH_CUSTOM:-${ZSH:-~/.oh-my-zsh}/custom}/plugins/zsh-completions
  

• 在 .zshrc 文件中，添加以下行到 source "$ZSH/oh-my-zsh.sh" 之前：

  fpath+=${ZSH_CUSTOM:-${ZSH:-~/.oh-my-zsh}/custom}/plugins/zsh-completions/src
  

注意：将其作为常规 oh-my-zsh 插件添加将无法正常工作。

使用 zinit

在 ~/.zshrc 文件中添加 zinit light zsh-users/zsh-completions。

手动安装

• 克隆仓库：

  git clone https://github.com/zsh-users/zsh-completions.git
  

• 将目录包含到 $fpath 中，例如在 ~/.zshrc 中添加：

  fpath=(path/to/zsh-completions/src $fpath)
  

• 可能需要强制重建 zcompdump：

  rm -f ~/.zcompdump; compinit
  

2. 项目的使用说明

zsh-completions 项目提供了额外的完成定义，以补充 Zsh 的功能。这些脚本在稳定后可能会贡献给 Zsh 项目。

3. 项目API使用文档

本项目不提供特定的 API 接口，它主要是一个 Zsh 的完成脚本集合。

4. 项目安装方式

请参考上述“安装指南”部分，了解如何在不同的系统和环境中安装 zsh-completions。