简单速查表

注意：此 CLI 工具处于非常早期阶段。

小巧直观的 CLI 工具，用于与您的速查表交互 o/

如何安装

使用 Cargo

cargo install <TBD>

设置

您可以使用环境变量配置三个不同的设置

• SCHEAT_CHEATSHEETS_PATH -> 存储速查表的路径
• SCHEAT_WIDTH -> 在终端显示时使用的总宽度
• SCHEAT_EDITOR -> 编辑速查表时使用的编辑器

默认值

• 速查表路径 -> $HOME/.cheatsheets
• 宽度 -> 80
• 编辑器 -> $EDITOR

如何使用

1. 定义速查表

速查表包含 部分。部分包含 速查。

要定义速查表，您需要指定具有以下格式的 yaml 文件

速查表.yaml

<Section Name>:
  - description: <Command Description>
    command: <Command>

示例

nvim.yaml

Tree:
  - description: Toggle Tree
    command: <leader>nt
  - description: Add File
    command: a

2. 使用 CLI

列出所有速查表

scheat list

显示速查表

scheat show <CHEATSHEET>

scheat show <CHEATSHEET> -s <SECTION>

编辑速查表

scheat edit <CHEATSHEET>

路线图

[X] 在 Yaml 中定义自己的速查表 [X] 列出速查表 [X] 显示速查表 [X] 显示速查表的部分 [X] 编辑速查表 [] 正确测试 :sweaty_smile: [] 良好的文档 :sweaty_smile: [] 创建新的速查表 [] 以更简洁的格式定义自己的速查表