A Ruby CL documentation utility for recording and playing back your thoughts/intel/motivations, without bloating the Git logs. ☕️
I have been assigned a secretary. Her name is Diane.
She seems an interesting cross between a saint and a cabaret singer.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install diane
diane record MESSAGE
diane record "I'm in the middle of adding git-lfs. Remind me to return + test."
--user USER: By default, Diane records the message and attributes it to the git user currently logged in. To override this, use the
diane record "the owls are not what they seem" --user "the_giant"
diane playback NUMBER
diane playback 3
--all: By default, Diane plays back 1 recording or the
NUMBERspecified. To override this, use the
--alloption to return every recording that matches the query.
diane playback --all
--user USER: By default, Diane plays back the recording(s) attributed to the git user currently logged in. To override this, use the
diane playback 3 --user "bob"
--everyone: If you want to return a
NUMBERof recordings irrespective of user, use the
diane playback --all --everyone
--inorder: By default, diane plays back the most recent recordings first. You can override this and reverse them with the option
diane playback 5 --inorder
Note: By default,
diane playbackwith no number or options returns the single most recent result by the logged in user.
For more, see Diane's Yardoc.
The gem is available as open source under the terms of the MIT License.