navi README

The project's README from github.com/denisidoro/navi. As one markdown file: README.md.

navi icon Actions Status GitHub release

An interactive cheatsheet tool for the command-line.

Demo

navi allows you to browse through cheatsheets (that you may write yourself or download from maintainers) and execute commands. Suggested values for arguments are dynamically displayed in a list.

Pros

It uses fzf or skim under the hood and it can be either used as a command or as a shell widget (à la Ctrl-R).

Table of contents

Installation

The recommended way to install navi is by running:

brew install navi

[!NOTE] For more details on how to install Navi, see docs/installation

navi can be installed with the following package managers:

Packaging status

Usage

There are multiple ways to use navi:

In particular, check these instructions if you want to replicate what's shown in the demo above.

Cheatsheet repositories

Running navi for the first time will help you download and manage cheatsheets. By default, they are stored at ~/.local/share/navi/cheats/.

You can also:

Cheatsheet syntax

Cheatsheets are described in .cheat files that look like this:

% git, code

# Change branch
git checkout <branch>

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

The full syntax and examples can be found here.

Customization

You can:

More info

Please run the following command to read more about all possible options:

navi --help

In addition, please check the /docs folder or the website.

navi (denisidoro/navi)

Searching Database…

17.8K ·GitHub
这是什么?navi 是一个命令行交互式速查表工具:你可以浏览速查表——自己编写的或从维护者那里下载的——并直接从中执行命令。
它是我导入到代码里的库,还是一个独立的应用?它是一个用 Rust 编写的独立交互式终端应用,不是库。你可以把它当普通命令运行,也可以作为类似 Ctrl-R 的 shell 小部件、Tmux 小部件、别名,或者 shell 脚本工具来使用。
我怎么把它装到电脑上?通过包管理器安装;README 里指向 docs/installation,那里有具体的安装命令。
它还需要安装别的东西才能用吗?有一个依赖值得知道:navi 构建在 fzf 或 skim 之上——正是这些模糊搜索工具支撑着它交互式选择命令的功能。
它在 Linux、macOS 和 Windows 上都能运行吗?它是跨平台的:仓库为 Linux、macOS 和 Windows 提供了安装包,Tmux 小部件模式甚至在远程机器的 SSH 会话里也能用。
第一次运行会发生什么?它会引导你下载和管理速查表。默认情况下,速查表存放在 ~/.local/share/navi/cheats/。
所有速查表都得我自己写吗?不用——你可以浏览精选速查表、从 git 仓库导入、复用 tldr 和 cheat.sh 的速查表、编写并分享自己的速查表、自动更新仓库,甚至可以通过插件从你的 TiddlyWiki 笔记自动导出速查表。
速查表文件长什么样?速查表是带简单语法的纯文本 .cheat 文件;完整的语法和示例在仓库的文档里有说明。
比起直接去谷歌命令,用它有什么好处?按照 README 的说法,navi 让你不必死记硬背各种命令行工具,省去复制粘贴中间命令输出的麻烦,让你打更少的字,还能顺带学到新的一行式命令。
What are similar projects?gum, gitui, cheat, bashka, z, fish-shell, zx, Gogh
Creator
denisidoro
Size
1.5 MB
Stars
17.8K
Age
7y
Commits · 90 Days