aboutsummaryrefslogtreecommitdiff
path: root/office/navi/README
diff options
context:
space:
mode:
Diffstat (limited to 'office/navi/README')
-rw-r--r--office/navi/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/office/navi/README b/office/navi/README
new file mode 100644
index 0000000000000..c0dbb337f20dc
--- /dev/null
+++ b/office/navi/README
@@ -0,0 +1,19 @@
+navi : An interactive cheatsheet tool for the command-line and
+application launchers.
+
+**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 will spare you from knowing CLIs by heart
+- it will spare you from copy-pasting output from intermediate commands
+- it will make you type less
+- it will teach you new one-liners
+
+It uses [fzf](https://github.com/junegunn/fzf),
+[skim](https://github.com/lotabout/skim),
+or [Alfred](https://www.alfredapp.com/) under the hood.
+It can be either used as a command or as a shell widget 'à la' Ctrl-R).
+
+Running navi the first time will help you download cheatsheets.