navi

命令行的交互式速查工具。

navi 允许你浏览速查表（你可以自己编写或从维护者那里下载）并执行命令。建议的参数值会动态显示在列表中。

优点

• 它将让你不必记住 CLI
• 它将让你不必复制粘贴中间命令的输出
• 它将让你输入更少
• 它将教会你新的单行命令

它底层使用 fzf，skim 或 Alfred，并且可以作为命令或作为 shell 小部件（例如 Ctrl-R）使用。

目录

• 安装
• 用法
• 速查表仓库
• 速查表语法
• 自定义
• 更多信息
• 在线试用
• 类似工具
• 词源

安装

navi 可以通过以下包管理器安装

安装 navi 的推荐方法是运行

brew install navi

如果 brew 不可用，你可以查看 替代安装说明。

用法

有多种方式可以使用 navi

• 在终端中键入 navi
  • 优点：你可以访问所有可能的子命令和标志
• 作为终端的 shell 小部件
  • 优点：shell 历史记录被正确填充（即使用实际运行的命令而不是 navi），你可以在执行之前编辑命令
• 作为一个 Tmux 小工具
  • 优点：您可以在任何命令行应用程序中使用您的速查表，即使在 SSH 会话中
• 作为 别名
• 作为一个 shell 脚本工具
• 作为一个 Alfred 工作流

特别地，如果您想复制上面演示中的内容，请检查这些说明。

速查表仓库

首次运行 navi 将帮助您下载和管理速查表。默认情况下，它们位于 ~/.local/share/navi/cheats/。

您还可以

• 浏览特色速查表
• 从 Git 仓库导入速查表
• 编写您自己的速查表（如果您想的话，还可以 分享它们）
• 使用来自其他工具的速查表，例如 tldr 和 cheat.sh
• 自动更新仓库
• 使用 TiddlyWiki 插件自动从您的 TiddlyWiki 笔记导出速查表

速查表语法

速查表由类似下面的 .cheat 文件描述

% git, code

# Change branch
git checkout <branch>

$ branch: git branch | awk '{print $NF}'

完整的语法和示例可以在 这里找到。

自定义

您可以进行以下操作

• 设置自己的配置文件
• 为您的配置文件和速查表设置自定义路径
• 更改颜色
• 调整列宽
• 更改搜索方式

更多信息

请运行以下命令以获取有关所有可能选项的更多信息

navi --help

此外，请查看 /docs 文件夹。

类似工具

那里有许多类似的项目（beavr、bro、cheat、cheat.sh、cmdmenu、eg、how2、howdoi、命令行界面页面 和 tldr 等）。

它们是优秀的项目，但 navi 在以下方面仍然独特

• 可以自然地编写适合您需求的速查表
• 参数既不是硬编码也不是简单的模板

词源

Navi 是来自 《塞尔达传说：时之笛》 的一个角色，他为 林克 提供了各种线索，帮助他解决谜题并在他的任务中取得进展。