consult-omni: 强大多功能的Emacs全能搜索插件

consult-omni简介

consult-omni是一款为Emacs设计的强大多功能全能搜索插件。它可以整合多种搜索源,在Emacs的minibuffer中提供类似MacOS Spotlight或Alfred的快速搜索和启动功能。consult-omni是consult-web的后续版本,具有更多扩展功能。

consult-omni围绕consult提供了一系列包装器和宏,使用户能够更轻松地从不同来源获取结果,并在全能式搜索中结合本地和网络源。换句话说,consult-omni支持在minibuffer中获取consult风格的多源或动态完成结果,适用于广泛的源,包括Emacs函数/包(如Emacs缓冲区、org文件、elfeed等)、命令行程序(grep、find、gh等)或网络搜索引擎(Google、Brave、Bing等)。

consult-omni可以作为其他全能搜索工具(如Alfred或MacOS spotlight)的开源免费替代品。它提供了一系列默认源作为示例,但主要思想是保持源的不可知性,为用户提供定义自己的源/工作流(又称插件)的工具集。

consult-omni示例

在上面的截图中,作者使用快捷键打开Emacs框架并调用consult-omni(类似于调用MacOS spotlight),搜索"emacs"一词,然后移动并查看来自不同源的预览,包括应用程序、gptel、Brave、Google、YouTube、elfeed、mu4e等。

consult-omni还可以用作应用程序启动器:

consult-omni启动器示例

主要特性

模块化设计: 用户可以只加载所需的部分。例如,如果只需要类似helm-google-autosuggest的自动建议实用程序,可以使用最小配置。
可定制和可扩展: 提供了大量自定义选项,既适用于源,也适用于对结果执行操作。可以根据需要添加新的源,支持不同格式、不同操作等。
强大的用户功能: 动态收集允许即时复杂工作流。可以通过传递参数来即时更改查询参数。可以临时选择一组随机结果并对其运行embark操作。这也允许批处理。
多源支持: consult-omni可以整合多种搜索源,包括:
- 网络搜索引擎(Google、Bing、Brave等)
- AI助手(ChatGPT、gptel等)
- 本地文件搜索(find、fd、grep、ripgrep等)
- Emacs内置功能(buffer、bookmark、org-agenda等)
- RSS订阅(elfeed)
- 邮件搜索(mu4e、notmuch)
- 学术参考文献(PubMed、Scopus等)
- 社区论坛(StackOverflow)
- 在线视频(YouTube、Invidious)
- 等等
动态完成: 支持动态搜索结果,可以在输入时实时显示搜索结果。
预览功能: 可以预览搜索结果,支持多种预览方式。
Embark集成: 提供了与Embark的集成,可以对搜索结果执行各种操作。
高度可配置: 提供了大量自定义选项,可以根据个人需求进行调整。

安装配置

系统要求

Emacs 28.0或更高版本
consult

推荐同时安装以下包以获得更好的体验:

安装方法

consult-omni目前不在ELPA或MELPA上,需要通过其他方式安装:

使用straight.el:

(straight-use-package
 '(consult-omni :type git :host github :repo "armindarvish/consult-omni" :files (:defaults "sources/*.el")))

或者使用use-package宏:

(use-package consult-omni
  :straight (consult-omni :type git :host github :repo "armindarvish/consult-omni" :files (:defaults "sources/*.el"))
  :after consult)

手动安装: 克隆仓库并确保文件在加载路径上。

基本配置

以下是一个基本的配置示例:

(use-package consult-omni
  :straight (consult-omni :type git :host github :repo "armindarvish/consult-omni" :branch "main" :files (:defaults "sources/*.el"))
  :after consult
  :custom
  (consult-omni-show-preview t) ; 显示预览
  (consult-omni-preview-key "C-o") ; 设置预览键为C-o
  :config
  (require 'consult-omni-sources)
  (require 'consult-omni-embark)
  
  ; 加载所有源模块
  (consult-omni-sources-load-modules)
  
  ; 设置多源搜索的源列表
  (setq consult-omni-multi-sources '("calc" "Apps" "Brave" "Dictionary" "Wikipedia" "elfeed" "Notes Search" "Org Agenda" "GitHub" "Invidious"))

  ; 设置默认交互命令
  (setq consult-omni-default-interactive-command #'consult-omni-multi))

使用方法

consult-omni提供了两种主要的多源交互命令:

consult-omni-multi: 动态命令,使用多个源,并在minibuffer完成中显示结果,支持动态完成(用户输入时获取结果)。
consult-omni-multi-static: 静态命令,使用多个源,在minibuffer完成中显示结果。用户提供一个搜索词,结果检索后,在minibuffer中输入将缩小候选范围。

使用这些命令时,可以通过以下语法传递参数和进一步缩小结果范围:

使用#分隔搜索词和缩小范围的关键词,例如:#emacs web search#github
使用--或:传递参数,例如:#how to browse a url in emacs -- --model gpt-3.5-turbo

自定义设置

consult-omni提供了大量自定义选项,以下是一些重要的设置:

consult-omni-sources-modules-to-load: 要加载的模块列表。
consult-omni-default-browse-function: 打开URL的默认浏览函数。
consult-omni-alternate-browse-function: 打开URL的备用浏览函数。
consult-omni-default-preview-function: 预览链接的默认函数。
consult-omni-show-preview: 是否显示预览。
consult-omni-preview-key: 默认预览键。
consult-omni-default-format-candidate: 格式化候选项的函数。
consult-omni-default-count: 每个源检索的默认结果数量。
consult-omni-group-by: 结果分组的字段。
consult-omni-multi-sources: 用于consult-omni-multi和consult-omni-multi-static命令的源名称列表。

结语

consult-omni为Emacs用户提供了一个强大而灵活的全能搜索工具。通过整合多种搜索源,它大大提高了在Emacs中的搜索和启动效率。虽然配置可能需要一些时间,但其高度可定制性使得用户可以根据个人需求打造出理想的工作流程。无论是快速查找信息、启动应用程序,还是执行复杂的搜索任务,consult-omni都能胜任。对于那些希望在Emacs中实现类似Spotlight或Alfred功能的用户来说,consult-omni无疑是一个值得尝试的优秀插件。