Navi项目：命令行速查表语法详解

Navi项目：命令行速查表语法详解

navi An interactive cheatsheet tool for the command-line 项目地址: https://gitcode.com/gh_mirrors/na/navi

前言

在命令行操作中，我们经常需要记忆各种复杂的命令和参数。Navi项目提供了一种优雅的解决方案，它允许用户创建和使用交互式命令行速查表。本文将深入解析Navi速查表的语法结构，帮助开发者高效地创建和管理自己的命令行工具集。

速查表基础结构

Navi速查表文件以.cheat或.cheat.md为扩展名，采用简洁明了的标记语法。一个典型的速查表文件包含以下核心元素：

1. 标签标题：以%开头，定义命令的标签和分类
2. 命令描述：以#开头，简要说明命令功能
3. 变量定义：以$开头，提供命令参数的预定义值
4. 执行命令：普通文本行，包含实际执行的命令

示例：

% git, version-control

# 切换分支
git checkout <branch>

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

变量系统详解

Navi的变量系统是其强大功能的核心，提供了灵活的交互式参数选择机制。

基础变量定义

变量使用尖括号定义在命令中，如<branch>。变量名应只包含字母数字和下划线字符。

高级变量选项

通过---分隔符可以为变量添加高级配置选项：

# 示例：自定义docker镜像选择
docker rmi <image_id>

$ image_id: docker images --- --column 3 --header-lines 1 --delimiter '\s\s+'

支持的主要参数包括：

• --column：指定结果中的列号
• --header-lines：跳过指定行数的标题
• --delimiter：设置字段分隔符
• --multi：允许多选
• --preview：添加预览窗口

变量依赖关系

变量可以相互引用，形成依赖关系：

1. 隐式依赖：直接使用<variable>语法引用

echo "<wallpaper_folder>"
$ pictures_folder: echo "/my/pictures"
$ wallpaper_folder: echo "<pictures_folder>/wallpapers"

2. 显式依赖：使用$variable语法引用

echo <x> <y>
$ x: echo "hello hi" | tr ' ' '\n'
$ y: echo "$x foo;$x bar" | tr ';' '\n'

多参数变量

变量可以支持多个参数值：

cat <jsons>
$ jsons: find . -iname '*.json' -type f -print --- --multi --expand

速查表扩展机制

Navi允许通过@标签扩展已有速查表，共享变量和上下文：

% dirs, common
$ pictures_folder: echo "/my/pictures"

% wallpapers
@ dirs, common
echo "<pictures_folder>/wallpapers"

多行命令与代码块

Navi支持两种方式定义多行命令：

1. 直接换行：使用反斜杠\连接多行

echo foo
true \
   && echo yes \
   || echo no

2. Markdown代码块：使用三重反引号包裹

```sh
git checkout <branch>
```

实用技巧与最佳实践

1. 变量映射：可以对变量值进行转换处理

$ mapped: echo 'false true' | tr ' ' '\n' --- --map "grep -q t && echo 1 || echo 0"

2. 预览功能：为复杂选择添加预览窗口

$ image_id: docker images --- --preview "docker inspect {}"

3. 默认查询：预设搜索条件

$ branch: git branch --- --query "main"

结语

Navi的速查表语法设计既简洁又强大，通过灵活的变量系统和扩展机制，可以满足各种复杂的命令行场景需求。掌握这些语法规则后，开发者可以构建出高效、易用的命令行工具集，显著提升工作效率。建议从简单的命令开始，逐步尝试更复杂的变量和依赖关系，最终打造出个性化的命令行生产力工具。

navi An interactive cheatsheet tool for the command-line 项目地址: https://gitcode.com/gh_mirrors/na/navi