こんな経験ありませんか？
- なんのディレクトリか忘れた
- 先輩からもらったデータのディレクトリ構造がなんのこっちゃわからん
- 初めて使うフレームワークのディレクトリ構造のメモがほしい
つくったもの
ls-Improvedというコマンド上で動作するlsっぽいコマンドです．
どんなもの？
このように，ディレクトリの説明をつけることができます．また，少しだけlsをリッチに表示してくれます．
例はrails tutorialの説明をrailsのデフォルトディレクトリの説明文としてつけました．
こんなことができます！
-
機械学習等の実験パラメータの整理
-
チーム開発におけるディレクトリ構造のコメント
-
ターミナル映え
導入方法
ローカルにpython環境が必要です．一応2系でも3系でも動きます！
pip install ls-Improved
python環境さえあれば，コマンドプロンプト等でも動きます．
基本的な使い方
lsi
ファイルと説明文が付いたディレクトリを表示してくれます．説明文が無い時はDirがデフォルトで付きます．
lsi -F
ファイルのみの表示をしてくれます．
lsi -D
説明文が付いたディレクトリを表示してくれます．
lsi -a
隠しファイルも含めて全て表示してくれます．
lsi -s "<検索ワード>"
このようにして，説明文から該当するディレクトリを検索することが可能です．
ディレクトリと説明文の両方で検索することができます．
mkdiri <ディレクトリ名> "<説明文>"
説明文を付けたディレクトリを作成することができます．
説明文を装飾する
-
\n：改行 -
;r;：赤色にする -
;g;：緑色にする -
;b;：青色にする -
;w;：白色にする -
;p;：紫にする -
;_;：アンダーラインをつける -
;e;：装飾を解除する
mkdiri -a <ディレクトリ名> "<説明文>"
すでに存在するディレクトリに説明文を上書きすることができます．
どうなってんの？
ディレクトリ内に隠しファイルとして.description.lsiというファイルが自動で作成されます．このファイルの中身を直接編集することも可能です．
最後に
筆者はvimが大好きなので，Vi-Improvedにあやかってls-Improvedと命名しました．ふざけた名前にしてしまい申し訳ありません．🙇♂️🙇♂️🙇♂️🙇♂️🙇♂️🙇♂️🙇♂️🙇♂️🙇♂️🙇♂️🙇♂️🙇♂️🙇♂️