kmdr - コマンドの実行内容を教えてくれるCLI
開発者であれば、ターミナルを使って各種コマンドを入力するかと思います。コマンドを探す際に、Webで検索する人も多いでしょう。そんな時、各種オプションがすでに付いており、それぞれの説明がないために何となく実行してしまったりしていないでしょうか。 きちんと把握していないコマンドを打つ際に使ってみて欲しいのがkmdrです。実行内容を解析し、その説明を行ってくれます。
kmdrの使い方
kmdr explainを使ってコマンドを調べます。
$ kmdr explain
? Enter your command: ls -al
ls -al
EXPLANATION
ls
List directory contents
-a, --all
Include hidden files and directories
-l
Use a long listing format
EXAMPLES
ls -a
List all files, including hidden files
ls -lh
Long format list with size displayed using human readable units (KB, MB, GB)
ls -lS
Long format list sorted by size (descending)
RELATED PROGRAMS
dir, sort, pwd, tree, find, mkdir
コマンドの順番に沿って説明されるので分かりやすいです。
? Enter your command: find ./ -name moongift
find ./ -name moongift
EXPLANATION
find
Search for files in a directory hierarchy
./
An operand
-name moongift
Base of file name (the path with the leading directories removed) matches shell pattern
pattern
EXAMPLES
find . -name *.gif
Find files by extension name .gif
find . -mtime 30
Find files modified in the last 30 days
find . -size +10M
Find files larger than 10 Megabytes
RELATED PROGRAMS
tree, du, echo, mkdir, rmdir, grep
kmdrを使えばコマンドを実行する前に、それぞれの引数が何であるか分かります。よく分からないコマンドを実行してトラブルになるのを避けられるでしょう。さらに調べることで、より深く学ぶきっかけにもなるはずです。
kmdrはTypeScript製のオープンソース・ソフトウェア(MIT License)です。
ediardo/kmdr-cli: ?The CLI learning tool for explaining commands from your terminal