Ubuntuでコマンドラインチートシート「Cheat」をインストールして活用する方法

CheatはPythonベースのコマンドラインツールで、システム管理者が便利なチートシートを閲覧・保存できるようにするソフトウェアです。指定したコマンドのプレーンテキスト形式の使用例を表示し、オプションや引数、よくある使い方を素早く思い出す手助けをしてくれます。Cheatはまさに「頻繁に使うけれど、暗記できるほどではないコマンド」のためのツールと言えるでしょう。

Cheatのインストール

Cheatをインストールする前に、まずシステムを最新の状態にしておきましょう。以下のコマンドを実行します。

$ sudo apt-get update && sudo apt-get upgrade

Cheatのインストールには、Pythonのパッケージ管理ツール「Pip」を使うのが最も簡単です。pipをインストールするには、次のコマンドを使用します。

$ sudo apt-get install python-pip

続いて、cheat本体をインストールします。

$ sudo pip install cheat

実行すると、以下のような出力が表示されます。

Collecting cheat
    Downloading cheat-2.1.24.tar.gz (42kB)
      100% |████████████████████████████████| 51kB 89kB/s
Collecting docopt>=0.6.1 (from cheat)
    Downloading docopt-0.6.2.tar.gz
Collecting pygments>=1.6.0 (from cheat)
    Downloading Pygments-2.1.3-py2.py3-none-any.whl (755kB)
      100% |████████████████████████████████| 757kB 892kB/s
Installing collected packages: docopt, pygments, cheat
    Running setup.py install for docopt ... done
    Running setup.py install for cheat ... done
Successfully installed cheat-2.1.24 docopt-0.6.2 pygments-2.1.3

インストールが完了したら、次のコマンドで正しく導入されたか確認できます。

$ cheat -v

出力例：

cheat 2.1.24

テキストエディターの設定

独自のチートシートを作成する前に、Cheatがデフォルトで使用するテキストエディターを設定しておきましょう。ここではvimを設定する例を示します。

$ export EDITOR=/usr/bin/vim

設定が正しく反映されているかは、次のコマンドで確認できます。

$ printenv EDITOR

出力例：

/usr/bin/vim

この設定を将来のすべてのシェルセッションでも永続的に有効にするには、環境変数の宣言を.bashrcファイルに追加する必要があります。.bashrcは、bashシェルセッションの開始時に自動的に読み込まれる設定ファイルのひとつです。編集するには、次のコマンドを実行します。

$ nano ~/.bashrc

ファイルを開いたら、以下のようにexportコマンドを追記します。

# If not running interactively, don't do anything
case $- in
*i*) ;;
*) return;;
esac

export EDITOR=/usr/bin/vim

# don't put duplicate lines or lines starting with space in the history.
# See bash(1) for more options
HISTCONTROL=ignoreboth

編集が完了したら、ファイルを保存して終了します。変更を即座に反映したい場合は、次のコマンドで.bashrcを再読み込みするか、新しいターミナルを開いてください。

$ source ~/.bashrc

Cheatの基本的な使い方

最もシンプルな使い方として、tailコマンドのチートシートを表示してみましょう。

$ cheat tail

出力例：

# ファイルの末尾10行を表示
tail file

# ファイルの末尾N行を表示
tail -n N file

# N行目以降を表示
tail -n +N file

# ファイルの末尾Nバイトを表示
tail -c N file

# ファイルの末尾10行を表示し、追記を待機（リアルタイム監視）
tail -f file

利用可能なすべてのチートシートの一覧を表示するには、次のコマンドを使用します。

$ cheat -l

出力例：

7z /usr/local/lib/python2.7/dist-packages/cheat/cheatsheets/7z
ab /usr/local/lib/python2.7/dist-packages/cheat/cheatsheets/ab
apk /usr/local/lib/python2.7/dist-packages/cheat/cheatsheets/apk
apt /usr/local/lib/python2.7/dist-packages/cheat/cheatsheets/apt
apt-get /usr/local/lib/python2.7/dist-packages/cheat/cheatsheets/apt-get
awk /usr/local/lib/python2.7/dist-packages/cheat/cheatsheets/awk
chmod /usr/local/lib/python2.7/dist-packages/cheat/cheatsheets/chmod
curl /usr/local/lib/python2.7/dist-packages/cheat/cheatsheets/curl
dd /usr/local/lib/python2.7/dist-packages/cheat/cheatsheets/dd
..............................................................................

チートシートの作成と編集

オリジナルのチートシートを作成するには、次のコマンドを使用します。

$ cheat -e tutorialspoint

ここで「tutorialspoint」は作成するチートシートの名前です。コマンドを実行すると空白のチートシートが開くので、自分のよく使うコマンドやオプションのメモを書き加えて保存しましょう。

チートシートの検索

登録済みのチートシートの中からキーワードを検索することもできます。

$ cheat -s tail

このコマンドは「tail」に関連する記述をすべてのチートシートから検索します。出力例：

asterisk:
    # SIPアカウントの詳細を表示
dnf:
    # 指定した文字列でパッケージ情報を検索
journalctl:
    # ログをリアルタイムでフォロー（tail -fと同様）
pip:
    # パッケージの詳細を表示
tail:
    tail file
    tail -n N file
    tail -n +N file
    tail -c N file
    tail -f file

以上で解説は終わりです。この記事を読めば、Ubuntuにコマンドラインのチートシートツール「Cheat」をインストールし、表示・作成・検索まで自在に活用できるようになったはずです。今後もLinuxに関する便利なトリックやTipsをお届けしていきますので、お楽しみに！