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, как виджет Tmux, как алиасы или как инструмент для скриптов в shell.
Как установить его на свой компьютер?Установите через пакетный менеджер; в README указано, что точные команды лежат в docs/installation.
Нужно ли что-то ещё установить, чтобы всё работало?Одна зависимость, о которой стоит знать: navi построен на fzf или skim — это нечёткие поисковики (fuzzy finders), которые обеспечивают интерактивный выбор команд.
Он будет работать и на Linux, и на macOS, и на Windows?Он кроссплатформенный: в репозитории есть сборки для Linux, macOS и Windows, а режим виджета Tmux работает даже внутри SSH-сессий на удалённых машинах.
Что произойдёт, когда я запущу его в первый раз?Он проведёт вас через скачивание шпаргалок и управление ими. По умолчанию они хранятся в ~/.local/share/navi/cheats/.
Все шпаргалки мне придётся писать самому?Нет — можно просматривать избранные шпаргалки, импортировать их из git-репозиториев, переиспользовать шпаргалки из tldr и cheat.sh, писать и делиться своими, автоматически обновлять репозитории и даже автоматически экспортировать их из своих заметок TiddlyWiki с помощью плагина.
Как выглядит файл шпаргалки?Шпаргалки — это обычные файлы .cheat с простым синтаксисом; полный синтаксис и примеры описаны в документации репозитория.
Чем это лучше, чем просто гуглить команды?Как сказано в README, navi избавляет от необходимости помнить CLI наизусть, спасает от копирования вывода промежуточных команд, заставляет печатать меньше и попутно знакомит с новыми однострочниками.
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