manコマンドを補完するコミュニティベースのチートシート的なコマンド『tldr』

manコマンドについて調べてたところ、manコマンドほどに記述があるわけではないが簡単な使い方や事例をgithub上で記述してコマンドやWebページで見れるようにする『tldr』なるものを見かけた。 コミュニティドリブンというだけあってか、コマンドの利用方法・使い方についてはgithub上のファイルを編集することで変更ができるようだ。

Webページ上から利用できるが、コマンドでも利用できる様子。 rubyやPython版もあるが、NodeJS版が基本のようだ。 なので今回はnpmコマンドでインストールする。

以下、CentOSの場合。

yum install -y epel-release
yum install -y nodejs npm
npm install -g tldr

tldrコマンドは、以下のように引数としてコマンド名を入れてやればいい。

tldr コマンド名

以下、実行結果。

[root@BS-PUB-CENT7-01 ~]# tldr grep

  grep

  Matches patterns in input text.
  Supports simple patterns and regular expressions.

  - Search for an exact string:
    grep search_string path/to/file

  - Search in case-insensitive mode:
    grep -i search_string path/to/file

  - Search recursively (ignoring non-text files) in current directory for an exact string:
    |

  - Use extended regular expressions (supporting ?, +, {}, () and |):
    grep -E ^regex$ path/to/file

  - Print 3 lines of [C]ontext around, [B]efore, or [A]fter each match:
    grep -C|B|A 3 search_string path/to/file

  - Print the count of matches instead of the matching text:
    grep -c search_string path/to/file

  - Print line number for each match:
    grep -n search_string path/to/file

  - Print file names with matches:
    grep -l search_string path/to/file

  - Use the standard input instead of a file:
    cat path/to/file | grep search_string

  - Invert match for excluding specific strings:
    grep -v search_string

[root@BS-PUB-CENT7-01 ~]# tldr sed

  sed

  Run replacements based on regular expressions.

  - Replace the first occurrence of a string in a file, and print the result:
    sed 's/find/replace/' filename

  - Replace all occurrences of an extended regular expression in a file:
    sed -r 's/regex/replace/g' filename

  - Replace all occurrences of a string in a file, overwriting the file (i.e. in-place):
    sed -i 's/find/replace/g' filename

  - Replace only on lines matching the line pattern:
    sed '/line_pattern/s/find/replace/' filename

  - Apply multiple find-replace expressions to a file:
    sed -e 's/find/replace/' -e 's/find/replace/' filename

  - Replace separator / by any other character not used in the find or replace patterns, e.g., #:
    sed 's#find#replace#' filename

簡単な使い方、使用例なら使えそうだ。

サーバではなく、クライアントとして使用しているMacとかLinuxに使うほうが多そう。 書かれてる内容的にも、manの置き換えではなくてあくまでも補完って感じだ。