Code Monkey home page Code Monkey logo

diane's Introduction

Diane

Gem Version license GitHub top language

Build Status Maintainability Test Coverage

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.



Installation

Add this line to your application's Gemfile:

gem 'diane'

And then execute:

$ bundle

Or install it yourself as:

$ gem install diane

Usage


diane screen gif


Diane has two subcommands: record and playback:

Record

Usage:

diane record MESSAGE

Example:

diane record "I'm in the middle of adding git-lfs. Remind me to return + test."

Options:

  • --user USER : By default, Diane records the message and attributes it to the git user currently logged in. To override this, use the --user option:

    diane record "the owls are not what they seem" --user "the_giant"

Playback

Usage:

diane playback NUMBER

Example:

diane playback 3

Options:

  • --all : By default, Diane plays back 1 recording or the NUMBER specified. To override this, use the --all option 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 --user option:

    diane playback 3 --user "bob"
  • --everyone : If you want to return a NUMBER of recordings irrespective of user, use the --everyone option.

    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 --inorder.

    diane playback 5 --inorder

Note: By default, diane playback with 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.

diane's People

Contributors

mnyrop avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

diane's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.