git のレポジトリ内で日記を書く

git-diary を作りました。 レポジトリ内に diary という名前で orphan な branch を作り、文章を空コミットのログとして記録します。

インストール

git-diary.sh を git-diary に rename して PATH の通ったところに置きます。

使い方

日記を書く

$ git diary add [text ...]

add を引数ありで実行した場合、それを日記として記録します。 引数がない場合、エディタを起動します。

$ git diary add My first diary.
Add new diary:

My first diary.
$ git diary add
# launch editor
Add new diary:

My diary 2.

日記を見る

基本的には diary ブランチを見るだけです。

$ git log diary

また、 diary list という専用コマンドもあり、これは alias.diary-list をブランチ名付きで実行します。

$ git config alias.diary-list "log --oneline --reverse"
$ git diary list
# >> git log --oneline --reverse diary
$ git diary list --grep=todo
# >> git log --oneline --reverse diary --grep=todo

設定

diary.branch

日記に用いるブランチ名。

diary.editor

日記を書くのに使うエディタ。これが設定されていない場合、普通コミットメッセージを書くのに使うエディタが起動します。

alias.diary-list

前述のとおり。設定されていない場合、 "log" が自動的に設定されます。