Go言語でREADMEなどをターミナルから参照できるツールを作った話

Go 言語で README などのドキュメントを参照できる TUI ツールを作成を作成したので少し機能紹介などをしたいと思います。

作ったもの

今回作ったのはdocatというツールです。

go install github.com/aqyuki/docat@latest

でインストールすることができます。このツールは、OSS などを GitHub からクローンした流れでそのまま README や LICENSE などを参照したいなと思ったので作成しました。そのため、そういったよく開くファイルをなるべく少ない手順で開けるように意識して作りました。

機能

1. ドキュメントのリスト化

   コマンドを実行したディレクトリ内にある（もしくは引数で指定したフォルダ内）のドキュメントをサブフォルダを含めて探索します。

2. ドキュメントのプレビュー表示

   フォルダ内のドキュメントをプレビュー表示することができます。現状、ソースコードをそのまま表示するだけなので、いずれはスタイルを適用して表示するようにしたいと思っています。

使い方

簡単な使い方は以下のとおりです

go install github.com/aqyuki/docat@latest # docatの最新版を取得

cd hoge # docatでドキュメントを参照したいフォルダに移動

docat list # ドキュメントの一覧を表示します

docat cat # ドキュメントをプレビューします。

まとめ

• ここで公開しているので良ければ使ってみてください。
• まだ機能が少ないので今後機能追加をしていきたいと思います。