Cheat sheets for the shell

Hitting Pause

What if you are not sure that you've chosen the correct command? For instances where the command will change your system, you can add the --print option to the command to prevent it from executing directly. If you want to use this option as a default, define a corresponding alias, such as

alias navi='navi --print'

and add it in your ~/.bashrc.

You also might want to use the --print option for commands that require further input before execution. For example, the Create a tar containing files task from the compression section requires two pieces of input from the user; the software prompts you for them when you click on the command. For name:, enter the desired name of the tar archive, while files: expects the path to the files you want to compress.

Once you have confirmed both entries, the tool will display the command that creates the corresponding archive (Figure 4). If you have used the --print option, navi will not execute this command, giving you the opportunity to determine if the command has the desired effect. If the command does what you expect, then copy the command and run it.

Figure 4: The command shown here for creating a tarball requires the user to enter a name and a path before the tool shows the command.

Online Cheat Sheets

Another way to use navi is to enter a command directly as an argument at launch time. For example, entering

navi search apt

will return eight commands for Debian's apt package tool. These commands do not originate from the installed navi package; instead, they come from online sources, such as [5], which offers additional cheat sheets (Figure 5).

Figure 5: You can use navi to integrate commands from online cheat sheets. However, you should investigate this type of command more thoroughly with --print before you take the plunge.

Integrating the Widget

You can also add navi to the shell as a widget, which helps keep the history up to date and lets you edit the command to suit your needs before running it.

To use the software as a widget, add the following line

source "$(navi widget bash)"

to your ~/.bashrc or /etc/bash.bashrc file. This lets you launch navi by pressing Ctrl+G in the future. If the keyboard shortcut is already assigned on your system, or if you want to assign a different shortcut, you can define it in /opt/navi/navi.plugin.bash.

Buy this article as PDF

Express-Checkout as PDF
Price $2.95
(incl. VAT)

Buy Linux Magazine

Get it on Google Play

US / Canada

Get it on Google Play

UK / Australia

Related content

  • Cheat: Cheatsheets for Command-Line Tools
  • FOSSPicks

    Like tardy London buses, Graham has waited months for a decent open source instant messenger client to arrive, and then in this month's FOSSPicks, he found two. Perfect for staying in touch with friends and family from the comfort of your own sofa.

  • The sys admin's daily grind:

    Whenever you really need documentation, it's almost always incomplete or outdated – or both. Sys admin columnist Charly K¸hnast recommends a radically different approach: the universal community documentation, which no Linux command and hardly any programming language should do without.

  • Cheat Sheet

    A simplified alternative to man pages, tldr provides the most common command options at a glance.

  • Jekyll

    Most people starting a blog will almost automatically turn to WordPress, which calls for PHP, a database, and regular security updates … and thus a lot of attention. With the small Jekyll template engine, you can avoid all that.

comments powered by Disqus
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters

Support Our Work

Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.

Learn More