navi <img src="https://yellow-cdn.veclightyear.com/2b54e442/0ea44af1-4578-40a7-ab85-d2807d6750a9.png" alt="图标" height="28px"/>

一款交互式命令行备忘工具。

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

优点

• 无需记住命令行界面
• 无需复制粘贴中间命令的输出
• 减少输入
• 学习新的单行命令

它底层使用 fzf、skim 或 Alfred，可以作为命令使用，也可以作为 shell 小部件使用（类似 Ctrl-R）。

目录

• 安装
• 使用
• 备忘录仓库
• 备忘录语法
• 自定义
• 更多信息
• 在线试用
• 类似工具
• 词源

安装

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

# 切换分支
git checkout <branch>

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

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

自定义

你可以：

• 设置自己的配置文件
• 为配置文件和备忘录设置自定义路径
• 更改颜色
• 调整列宽
• 更改搜索方式

更多信息

请运行以下命令以了解所有可能的选项：

navi --help

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

类似工具

有许多类似的项目（beavr、bro、cheat、cheat.sh、cmdmenu、eg、how2、howdoi、Command Line Interface Pages 和 tldr，仅举几例）。

它们都是优秀的项目，但 navi 在以下方面保持独特：

• 编写适合自己需求的备忘录很自然
• 参数既不是硬编码的，也不是简单的模板

词源

Navi 是《塞尔达传说：时之笛》（The Legend of Zelda Ocarina of Time）中的一个角色，为 林克 提供各种线索，帮助他解决谜题并在冒险中取得进展。