eg - コマンドラインから参照できる、Unixコマンドの実践的サンプル集

ターミナルを使い慣れた人にとっても、findのような複雑なUNIXコマンドの使い方を、常に正確に覚えておくことは困難なことかもしれません。manでドキュメントを参照することもできますが、探したい情報が素早く見つけられないので、あまり活用していないという方も多いでしょう。

本日紹介する「eg」はコマンドラインから使うことができる、UNIXコマンドの実践的なサンプル集をまとめたドキュメント検索ソフトです。

「eg find」のように入力すると、findの具体的な使い方が表示されます。やりたいことと具体例がペアで表示されるので、目的の情報を素早く見つけ出すことができます。毎回Googleで検索する日々から脱却できるかもしれません。

インストール

pipコマンドでインストールできます。

pip install eg

pipを使わず、直接git cloneすることもできます。

使用方法

「eg find」のように使います。

あるディレクトリ以下のファイルを探す方法、ディレクトリだけを探す方法、さらに追加で情報を表示する方法などがリストアップされました。

egは、Markdown形式のドキュメントの情報を表示していて、findの場合は「find.md」というファイルの情報を表示しています。

eg --examples-dir='the/default/dir' --custom-dir='my/fancy/dir' find

自分用のカスタム「find.md」を作成して、--custom-dirで指定すれば、そのドキュメントを優先して表示してくれます。

[eg-config]
examples-dir = ~/examples-dir
custom-dir = ~/my/fancy/custom/dir

設定はコマンドラインで指定できるほか、~/.egrcに記述することもできます。

デフォルトのドキュメントで満足せず、自分なりのドキュメントを作りこんでいくと、とても役に立つコマンドとなりそうですね。