navi

name	navi
description	An interactive cheatsheet tool for the command-line. WHEN: run `navi` commands. Triggers: use navi, install navi, how to use navi, run navi.

navi

An interactive cheatsheet tool for the command-line.

When to Use

• Run navi commands

When NOT to Use

• GUI or web-based workflows where CLI is not available
• Projects using Python or JavaScript (different ecosystem)

Quick Start

Install

brew install navi

Basic Usage

There are multiple ways to use navi:

• by typing navi in the terminal
  • pros: you have access to all possible subcommands and flags
• as a shell widget for the terminal
  • pros: the shell history is correctly populated (i.e. with the actual command you ran instead of navi) and you can edit the command as you wish before executing it
• as a Tmux widget
  • pros: you can use your cheatsheets in any command-line app even in SSH sessions
• as aliases
• as a shell scripting tool

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

CLI Commands

• navi

Project Info

• Language: C, Rust
• License: Apache-2.0
• Tests: Yes

File Structure

├── assets/
│   ├── icon.png
│   └── icon.svg
├── docs/
│   ├── cheatsheet/
│   ├── configuration/
│   ├── contributions/
│   ├── deprecated/
│   ├── examples/
│   ├── installation/
│   ├── usage/
│   ├── widgets/
│   └── README.md
├── scripts/
│   ├── docker
│   ├── dot
│   ├── install
│   ├── make
│   ├── release
│   └── test

Generated by repo2skill