fz.sh 项目使用教程

1. 项目目录结构及介绍

fz.sh 项目是一个为命令行 shell 提供模糊搜索路径完成功能的插件。项目的主要目录结构如下：

• LICENSE：项目使用的许可证文件，本项目采用 MPL-2.0 许可。
• README-zh.md：项目的中文说明文档，包含了项目介绍、安装方法和使用说明。
• README.md：项目的英文说明文档。
• fz-demo.gif：项目的功能演示动图。
• fz.bash：为 Bash shell 提供的插件脚本。
• fz.plugin.zsh：为 zsh shell 提供的插件脚本。
• fz.sh：插件的主要脚本文件，用于在 Bash 或 zsh 中添加模糊路径完成功能。

2. 项目的启动文件介绍

项目的启动主要是通过在 shell 的配置文件中（如 ~/.bashrc 或 ~/.zshrc）引入插件脚本。

对于 Bash 用户，需要在 ~/.bashrc 文件中添加以下内容：

if [ -d ~/.bash_completion.d ]; then
  for file in ~/.bash_completion.d/*; do
    . $file
  done
fi

对于 zsh 用户，需要在 ~/.zshrc 文件中添加以下内容：

zplug "changyuheng/fz", defer:1
zplug "rupa/z", use:z.sh

添加后，重新加载配置文件或重启终端即可。

3. 项目的配置文件介绍

fz.sh 插件支持一些配置变量，用户可以根据自己的需要修改这些变量。

• FZ_CMD：指定 fz 命令的名称，默认为 z。
• FZ_SUBDIR_CMD：指定子目录搜索命令的名称，默认为 zz。
• FZ_SUBDIR_TRAVERSAL：是否启用子目录完成，默认为 1（启用）。
• FZ_CASE_INSENSITIVE：是否启用不区分大小写的子目录完成，默认为 1（启用）。
• FZ_ABBREVIATE_HOME：是否缩写 ~，默认为 1（启用）。
• FZ_HISTORY_CD_CMD：与 z.lua 配合使用的历史 CD 命令，默认为 _zlua。

用户可以在插件脚本文件中或 shell 配置文件中设置这些变量。例如，在 ~/.bashrc 或 ~/.zshrc 文件中添加以下内容：

export FZ_SUBDIR_TRAVERSAL=0
export FZ_CASE_INSENSITIVE=0

这将禁用子目录完成，并关闭不区分大小写的子目录完成功能。