如果你常年在 Linux 终端里敲命令一定早就习惯了一个动作输到一半按两下 Tab候选命令瞬间列出来。让你实现这个便利的是 Bash 内置命令 compgen。不少人在脚本里也见过它但大多数时候它都被当成幕后工具忽略掉了。实际上compgen 完全不依赖外部程序直接由 Bash 生成补全候选既能帮你摸清系统里有哪些命令、别名、变量和文件又能作为自定义补全的核心引擎。这篇内容我会从基础参数讲起再带你走一遍和 complete 配合做自定义补全的完整链路最后聊几个我实际踩过的坑。如果你平时会写运维脚本或者想给自研命令行工具加一套好用的参数补全这篇应该能帮你省不少时间。1. compgen 是什么藏在 Tab 补全背后的原生引擎1.1 先搞清楚它的身份compgen 不是一个独立安装的外部命令比如你到/usr/bin下面找根本找不到这个名字。它是 Bash 自己的内置命令加载 Bash 的时候就一直存在。想验证这一点可以直接执行type compgen你会看到输出类似compgen is a shell builtin这意味着它在任何最小化的 Linux 发行版里都可用不依赖额外安装 bash-completion 包。这也是它在脚本里特别省心的原因不需要担心别人的生产环境里有没有这个工具。Bash 的自动补全流程是当你在命令行按下 TabBash 根据当前输入调用补全相关逻辑最终会用类似 compgen 的机制去生成候选词。bash-completion这个第三方项目里的各类补全脚本归根结底也是通过调用 compgen 或者直接操作COMPREPLY数组来对候选词排序、过滤。1.2 基本语法和最简单的例子compgen 的基本语法是compgen [选项] [关键词]它做的事情很简单根据选项确定候选来源再用关键词做前缀过滤把匹配的行一条一条输出到标准输出。举个例子compgen -c sys-c表示候选来源是所有可执行命令sys是过滤关键词。你会看到类似systemctl、sysctl、sysstat这样的输出这些都是以sys开头的命令。这里需要注意compgen 的过滤是严格的前缀匹配不是子串匹配更不是模糊匹配。如果你输入system就不会返回sysstat因为sysstat不以system开头。1.3 和 complete 命令的分工讲 compgen 就绕不开complete。这两个命令的分工很容易混complete是注册补全规则告诉 Bash某个命令的参数补全应该按照什么规则生成compgen是真正干活的那一步按照规则生成候选词。可以理解为 complete 负责制定规则compgen 负责执行清单。比如你写一行complete -W start stop restart service这行注册完以后输入service 空格TabBash 会显示start stop restart三个候选。这个-W动作底层就是用 compgen 的-W选项去匹配当前输入词。后面我会专门展开讲。2. 常用参数拆解命令、别名、内置函数、关键字2.1 列出系统命令-c-c是最有实践意义的参数之一它能够列出当前 shell 环境所有可以执行的命令候选。注意这里的命令范围比外部程序大它包含 PATH 环境变量里所有可执行文件、Bash 内置命令、以及已定义的函数名。想数一数到底有多少可以接管道统计compgen -c | wc -l不同机器输出差别很大取决于安装软件多少、PATH 配置和自定义 shell 函数。有一点容易误解有人以为compgen -c只列/bin或/usr/bin里的文件其实它会把 PATH 下的全部可执行文件都扫进来包括/usr/local/bin、用户自己的二进制目录等等。实际过滤也很常见配合 grep 找某个软件相关的命令compgen -c | grep -i docker2.2 别名与内置命令-a 和 -b-a列出当前 shell 中定义的所有别名compgen -a你在.bashrc里写的alias llls -l之类都会出现在里面。-b列出 Bash 内置命令比如cd、echo、read、export等都是内置命令数量不算多但能帮你确认某个词到底是外部命令还是内置命令。组合使用时可以直接把类别合并展示。比如先输出别名再输出命令可以用compgen -a和compgen -c配合管道但要注意顺序。有时候你想知道ls到底是别名还是命令先执行compgen -a ls compgen -c ls如果第一个有输出说明存在别名如果只有第二个有输出说明只是命令。这个思路在排查 shell 环境问题时很实用。2.3 关键字-k-k列出 Bash 的关键字也就是 shell 语法中的保留字比如if、then、else、fi、for、while、case、function、select等。这类词虽然不能当普通命令执行但很多补全脚本会把你输入的命令和这些关键字混在一起避免你把保留字当成命令。2.4 类别参数一览参数候选来源典型使用-c所有可执行命令compgen -c ssh-a别名compgen -a ll-bBash 内置命令compgen -b read-kShell 关键字compgen -k if-f文件名compgen -f /var/-d目录名compgen -d /e-v变量名compgen -v PATH-u系统用户compgen -u root-g系统用户组compgen -g sudo-W自定义单词列表compgen -W a b c -- b-X过滤模式compgen -X *.log -f3. 文件、目录、变量与系统账号资源类补全3.1 文件名与目录-f 和 -d-f列出文件名-d只列出目录名。两者在自定义补全里出镜率很高因为很多工具的参数值就是文件路径或者目录路径。例如compgen -f /var/会输出/var/下面的所有文件和目录注意它是包含完整前缀路径的。如果你输入/var/lo它就会用这个前缀过滤结果可能只有/var/log。这个方法实现路径补全非常自然不需要你自己去解析目录再拼接。-d更适合只需要目录的场合。比如一个发布脚本你希望参数必须是某个目录而不是普通文件直接用compgen -d /opt/就能列出来/opt/下的目录。需要注意裸用compgen -d不带任何路径时它列的是当前目录下的目录想在补全逻辑里把当前前缀路径顺出来需要自己截取$COMP_WORDS[COMP_CWORD]前面那一截。3.2 变量名-v-v列出当前环境的所有变量名。配合前缀过滤这个在写 shell 补全的时候非常好使compgen -v P会输出 PATH、PWD、PPID、PS1 等等。注意它只回显变量名不显示变量值这是补全场景需要的形态。如果想知道变量值你得靠echo ${!var}这类间接展开。3.3 用户和组-u 和 -g-u列出系统用户-g列出用户组。它们在需要处理用户身份的工具中很有用比如你想做一个chown的补全函数可以从/etc/passwd或getent读取但直接用 compgen 更符合 Bash 风格compgen -u | grep ^sys输出以sys开头的用户名比如sys、systemd-*这类系统账户。-g同理列出组名。这里有个小坑默认的compgen -u不会做活动会话的过滤它读的是系统账户数据库跟当前登录用户没太大关系所以输出里会出现大量系统服务账户这很正常。3.4 把多个资源类参数串起来实际操作里你不会只单独用某一个。比如一个补全函数可以根据当前命令行的位置决定该用文件还是命令还是用户。可以把所有可能的结果合并排序compgen -f compgen -d两条命令输出可能会有重复比如目录同时出现在-f和-d的结果里。因此要特别提醒如果你把它们都塞进 COMPREPLY一定要用sort -u去重否则 Tab 补全时会看到重复候选交互体验很烂。4. 自定义补全的两大利器-W 和 -X4.1 -W 的单词列表玩法-W大概是 compgen 最亲民的参数它允许你直接指定一个候选单词列表然后让 compgen 去根据前缀匹配过滤。语法是compgen -W word1 word2 word3 -- 前缀比如compgen -W start stop restart reload status -- st输出只有start和status两个词因为只有它们以st开头。这里的--是分隔符表示后面不再解析参数避免某个前缀以-开头时被误当成选项。这个细节很多人容易漏建议你在给工具写补全时养成加--的习惯。4.2 -W 配合命令替换实现动态补全-W最大的威力是可以动态生成单词列表。你完全可以写compgen -W $(cat /etc/nginx/sites-enabled/* | grep -oP server_name\s\K[^;]) -- $cur这样一来候选词不是写死的而是根据当前配置实时算出来的。再看一个更常见的例子给 systemctl 服务名做补全compgen -W $(systemctl list-units --no-legend | awk {print $1}) -- $cur这种做法比写死单词列表可靠得多服务增减后不需要改脚本。不过你要注意性能问题命令替换里的命令每次 Tab 都会执行一次如果命令本身跑得慢终端补全会变得很卡。4.3 -X 做排除过滤-X和-W刚好相反-W是只要这些-X是排除这些。它接受一个 shell 通配符模式匹配到的候选会从结果中过滤掉。用法compgen -f -X *.log这个命令会列出当前目录下的所有文件但把所有.log结尾的文件过滤掉。这里我强烈建议和-f一起用因为单纯用-X不指定候选来源你会得到非常反直觉的结果。它的实现原理是对每个候选做模式匹配命中即剔除。排除模式还支持一个特殊前缀!表示反转只保留匹配该模式的候选。这个特性在做白名单式过滤的时候非常有用compgen -f -X !*.conf这句的意思是只输出以.conf结尾的文件。4.4 组合示例只筛选可执行文件假设你想在某个目录里列出所有可执行文件作为命令候选单纯的-f做不到-X也做不到因为-X只按名字过滤不检查权限。你可以换一个思路用 compgen 拿到文件名列表然后交给-x测试可执行权限for f in $(compgen -f ./bin/); do [ -x $f ] echo $f done这里compgen -f ./bin/会返回带./bin/前缀的完整路径-x测试每条路径是否具备可执行权限。虽然比一条纯 compgen 命令要多包一层循环但效果稳定。这也提醒我们compgen 只是补全工具箱里的扳手真正的判断逻辑还得靠其它 shell 操作配合。5. 从 compgen 到 complete亲手做一套自定义参数补全5.1 最简单的方式complete -W 直接注册在自定义补全里最常见的手法就是complete -W。它是 compgen -W 的上层封装。举个例子我有个内部部署脚本deploy.sh它只接受test、pre、prod三个环境参数complete -W test pre prod ./deploy.sh注册之后在命令行输入./deploy.sh TabTabBash 会自动列出三个候选词。如果输入pTab会自动补全成pre。注意complete通过前缀匹配会选择左侧第一个匹配因为pre和prod都匹配p所以会两个都列出来而不是直接确定。这种方式适合参数固定、变化少的工具。但实际工具有很多参数是动态的比如要补全本地文件名、远程主机名这时候写死列表就不太现实了需要进入函数补全。5.2 用补全函数包装 compgen补全函数的套路如下在函数里读取当前输入词、前一个词、当前命令名然后调用 compgen 生成 COMPREPLY 数组。我来展示一个完整的示例目标是让mygit命令支持clone、commit、branch、checkout等子命令_mygit_completion() { local cur prev cur${COMP_WORDS[COMP_CWORD]} prev${COMP_WORDS[COMP_CWORD-1]} local commandsclone commit branch checkout pull push status log local branches case $prev in checkout|switch) branches$(git branch --format%(refname:short) 2/dev/null) COMPREPLY($(compgen -W $branches -- $cur)) ;; *) COMPREPLY($(compgen -W $commands -- $cur)) ;; esac return 0 } complete -F _mygit_completion mygit这里的关键就是compgen -W $branches -- $cur。无论候选来自静态命令列表还是动态分支名都用同一套 compgen 语法做前缀过滤然后把结果塞进 COMPREPLY。Bash 补全机制要求候选词必须通过名为 COMPREPLY 的数组返回这是协议。如果忘了赋值Bash 就认为没有候选不会有任何补全输出。我实际测试过这个脚本当输入的cur是空字符串时compgen 会把所有候选原样输出这正好符合补全第一屏的预期。唯一要注意的是当候选词里有带空格的路径名时COMPREPLY的元素需要正确转义通常用数组直接赋值能保留空格语义。5.3 获取当前光标前的词和上一个词上面例子里的${COMP_WORDS[COMP_CWORD]}和${COMP_WORDS[COMP_CWORD-1]}不是随便写的。Bash 在触发补全时会填充几个环境变量给补全函数使用COMP_WORDS当前命令行被拆分成词的数组。COMP_CWORD当前光标所在词的索引。COMP_LINE整行命令文本。这是补全函数获取上下文的主要来源。假设用户输入的是mygit checkout maTab那么COMP_WORDS大概是mygit checkout maCOMP_CWORD是 2cur是maprev是checkout。这样你才能根据prev来决定用哪套候选这是自定义补全函数通用套路。5.4 文件路径补全的惯例处理在补全函数里有一个非常容易踩的坑如果你直接调用compgen -f $cur在补全路径时不会生成带转义的空格文件夹名。手册级别的做法是先分离出目录部分和文件名部分再用readline的引号处理机制交给 Bash 处理。例如_myedit_completion() { local cur cur${COMP_WORDS[COMP_CWORD]} COMPREPLY( $(compgen -f -- $cur) ) } complete -F _myedit_completion myedit这个基本可用。但它和原生日路径补全相比少了~展开、$var展开等高级功能。如果只是内部工具这样已经足够如果要追求和ls一样的体验建议检查目录名是否以/结尾再手工拼接完整路径。6. 运维脚本里的 compgen 实用技巧6.1 用 compgen -c 判断命令是否存在脚本里判断某个命令是否存在很多人会用command -v或者which。但在某些场景下compgen -c也很方便特别是你想判断当前 shell 环境里有没有兼容某个前缀的一批命令时。例如要检测一批网络工具for cmd in curl wget nc ss ip; do if compgen -c $cmd /dev/null; then echo $cmd 存在 else echo $cmd 不存在 fi done这里compgen -c $cmd只要存在前缀匹配就会输出所以用它做存在性检测时要注意前缀问题。compgen -c curl能匹配curl也能匹配curlftpfs之类以 curl 开头的命令。严格判断某个完整命令是否有一个独立的可执行文件时还是用command -v更准确。这点属于使用边界别被误导。6.2 快速找出系统里所有可用命令的类别运维排障时可以通过对比compgen -c和compgen -b搞清楚某条命令是不是 Bash 内置compgen -b | sort compgen -c | sort按comm对比两个输出就能列出所有外部命令中内置命令以外的部分这对理解为什么某些命令在所有 Linux 环境都可用挺有帮助。比如cd、export是内置的所以任何环境都能用但cut是外部命令某些精简容器里可能没有。6.3 在 shell 菜单交互里生成选项如果你写过那种在终端里让用户选择编号的脚本compgen -W也能帮你生成菜单options$(compgen -W start stop restart -- )变量options里就是完整的候选词。其实现逻辑是如果前缀是空字符串compgen -W不会过滤任何词直接全量输出。你可以在一个select循环里这样用select action in $(compgen -W start stop restart -- ); do case $action in start) ./app.sh start ;; stop) ./app.sh stop ;; restart) ./app.sh restart ;; *) break ;; esac done这种写法看起来多绕了一层好处是候选词只需要维护一份列表以后要加一个reload改一行就够菜单和补全都会同步变。6.4 用 compgen 调试补全脚本很多补全脚本写得复杂以后一个常见的问题是我按 Tab 为什么不出候选定位思路很简单在补全函数里临时加一行输出把COMPREPLY内容打印到文件。但更快的思路是直接在命令行模拟 compgen。比如怀疑候选列表没生成对先手动执行compgen -W $(git branch --format%(refname:short)) -- $cur这里$cur换成实际的输入前缀就能马上看出来是候选列表本身错了还是 COMPREPLY 赋值环节出了问题。我的经验是大约 80% 的补全 bug 都能在 compgen 这一步暴露出来排查效率远高于一遍遍改补全函数然后 bash 子进程试。6.5 性能问题命令替换别太频繁前面提到动态列表的性能问题这里多说一句。compgen 本身执行很快它就是内存里做前缀匹配几乎无开销。真正慢的是它参数里嵌套的命令替换。比如compgen -W $(some_slow_command)每次 Tab 都要重新执行some_slow_command网络请求类命令能卡到 1 秒甚至更久。我见过比较极端的举例补全函数里调用kubectl get pods来列服务名K8s API 一慢整个终端补全都卡死。解决办法是缓存结果或者在前台命令完成后用通知类机制更新缓存。简单点可以写一个缓存文件带过期时间高级做法需要 hook 事件但多数场景用不到能想到这个维度已经能少踩很多坑。7. 踩坑记录与常见问题速查7.1 隐藏文件不会自动参与文件补全compgen -f默认把所有文件都列出来包括.bashrc这类隐藏文件。但 Bash 的 readline 在展示补全时对以.开头的文件有自己的处理策略如果你输入ls .再按 Tab它会提示使用prefixl之类的操作。你可以直接用compgen -f验证它会老老实实输出隐藏文件。需要把隐藏文件从候选中排除时可以用-X .*过滤。7.2 前缀匹配是大小写敏感的compgen 的前缀匹配严格区分大小写这是很多新手的意外点。compgen -c SSH在绝大多数 Linux 环境是没有任何输出的因为命令名是ssh小写。如果你希望忽略大小写不能靠 compgen 参数得自己转换compgen -c | grep -i ^$cur这样就把大小写不敏感的活儿交给 grep而不是 compgen。代价是放弃了 Bash 原生的快速过滤机制但这在候选数量不大时可接受。7.3 -X 的综合坑匹配基名还是完整路径-X的匹配模式作用在上文-f生成的完整路径上而不是仅仅文件名。例如compgen -f /tmp/ -X *.log你想要的是不包含.log结尾的路径但实际匹配时如果/tmp/下存在foo.log输出里面不会有它。这个行为符合直觉。但如果你在比较深层级比如compgen -f /var/ -X *.log它不会因为路径里含有log结尾而中招百分百判断最终返回字符串的匹配。这个细节通常不会出问题但一旦你试图用-X过滤某个目录下的文件时一定记得模式匹配的是完整输出字符串不是 basename。7.4 空参数被误当成空匹配写补全函数时如果忘记--恰好cur又是-开头compgen 会把-当作选项去解析轻则不匹配重则直接报错误信息。比如compgen -W start stop -s会输出invalid option。解决方式就是在所有-W、-f配合外部输入时严格用--分隔。这不是可选项应该成为习惯。7.5 不同 Bash 版本下行为基本稳定我先后在 CentOS 7 的 4.2 版本、Ubuntu 22.04 的 5.1 版本以及 macOS 自带的 3.2 版本上测过 compgen 的核心参数结果基本一致。唯一比较明显的差异是老版本 Bash 对某些组合参数比如-X和-f一起用的边界处理稍弱但正常用法输出都稳定。所以你可以放心在脚本里使用大可不必担心我这台的 compgen 跟你那台不一样这种问题。7.6 常见问题速查表问题表现可能原因解决办法compgen -W报 invalid option关键词以-开头被当成选项在--后传入关键词补全函数按 Tab 没反应COMPREPLY 未正确赋值在函数末尾显式COMPREPLY($(compgen ...))候选列表有重复项同时用了-f和-d目录被输出两次对 COMPREPLY 做sort -u命令行工具补全参数永远不生效complete 注册时用了路径别名但命令实际调用的是另一个 symlink用complete -p查看实际注册情况服务名补全卡顿每次 Tab 都执行慢命令加缓存或者降低命令执行频率隐藏文件混进候选列表未做-X .*过滤根据需求过滤掉点开头文件根据我个人操作经验最后再补充一个所有补全脚本都值得注意的细节补全函数里不要过度设计。很多人喜欢在函数里叠加大量条件分支结果维护成本很高。更合理的方式是把候选列表的生成逻辑尽量集中用几个清晰的 case 分支区分当前参数应该补全什么剩下的都交给 compgen 做前缀过滤。你写的脚本越简洁后面排查问题的时候就越轻松。