如何从我自己的脚本中为 fish shell 提供选项卡补全？答案

【问题标题】：How can I provide tab completions to fish shell from my own script?如何从我自己的脚本中为 fish shell 提供选项卡补全？
【发布时间】：2014-01-17 06:20:56
【问题描述】：

我正在运行 Ubuntu 13.10 和 fish 2.1.0。我想为自己编写一个 Python 脚本来从命令行执行一些任务。该脚本将需要命令行参数。

如何编写我的脚本，以便鱼可以请求并获取给定参数的可能值。潜在价值列表是动态的。也就是说，它将以编程方式确定（例如，与某些条件匹配的文件夹名称列表）。

我想要的最终结果是这样的：

user@machine ~> myprog argument=fol<TAB>
folder1  folder2  folder3

myprog 是我的脚本文件，argument 是参数名称，folder1 等是我脚本中某个函数生成的有效值。

这可能吗？如果可以，怎么做？

【问题讨论】：

你应该为你的脚本创建一个鱼自动完成功能 (stackoverflow.com/questions/16657803/…)
@furins 所以tab-completion只能通过编写额外的shell脚本来提供？没有办法提供鱼（和其他外壳）可以查询的接口以实时提取完成？
也许我正在寻找这个 bash-helper 的鱼等价物：pypi.python.org/pypi/argcomplete/0.6.5
请注意argcomplete 需要您启动一个名为activate-global-python-argcomplete pypi.python.org/pypi/argcomplete/… 的bash 脚本才能工作（同样，如果您想复制这种方法，您必须编写一个shell 脚本)
自我说明：另请参阅github.com/dbarnett/python-selfcompletion 和furius.ca/optcomplete，了解更多 Python 方面的尝试

标签： shell autocomplete tab-completion fish

【解决方案1】：

您应该为您的脚本创建一个fish autocomplete function 和source 它或将它放在~/.config/fish/completions/myprog.fish 文件夹中。

参考：fish docs

【讨论】：

Docs path
感谢@AlexandrePaes，我已经更新了答案

【解决方案2】：

改编自zanchey's comment on GitHub：

如果您有一个程序myprog 采用--_completion 选项，您可以为myprog 编写一个完成存根，如下所示：

complete --command myprog --arguments '(myprog --_completion (commandline -cp)'

然后您的程序将被调用为myprog --_completion myprog some arguments here，并且您可以使用适当的完成来响应。它应该只返回正在完成的当前令牌（您也可以使用(commandline -ct) 将其传递给程序，或自己对其进行令牌化），后跟一个选项卡和一个简短的描述（可选）。多个补全用新行分隔。

注意事项：

--_completion 是 python-selfcompletion 库建议的约定，但你可以使用任何你想要的东西，而且这个答案不是 Python 特定的
无法指定默认完成，如dbarnett/python-selfcompletion#2 (GitHub comment) 中所述。您肯定需要为每个命令创建一个短存根。

特别是对于 Python 脚本，以下库可能会在未来某个时候支持鱼补全（但目前还不支持）：

【讨论】：

我试过类似的命令。当我在 Fish 会话中执行它时它确实起作用了，但是当我将它放入 config.fish 时它不起作用。