# Waddup

[![Gem Version](https://img.shields.io/gem/v/waddup.svg?style=flat)](https://rubygems.org/gems/waddup)
[![Build Status](https://img.shields.io/travis/timkurvers/waddup.svg?style=flat)](https://travis-ci.org/timkurvers/waddup)
[![Dependency Status](https://img.shields.io/gemnasium/timkurvers/waddup.svg?style=flat)](https://gemnasium.com/timkurvers/waddup)
[![Code Climate](https://img.shields.io/codeclimate/github/timkurvers/waddup.svg?style=flat)](https://codeclimate.com/github/timkurvers/waddup)
[![Coverage Status](https://img.shields.io/coveralls/timkurvers/waddup.svg?style=flat)](https://coveralls.io/r/timkurvers/waddup)

Waddup is a Ruby gem that retraces your activities from arbitrary sources - such as version control, issue tracking software and mail clients - and displays them in a neat chronological overview.

Perfect for those who have lost track of what they have worked on.

**Supported Ruby versions: 1.9.3 or higher**

Licensed under the **MIT** license, see LICENSE for more information.

![Waddup](http://office.moonsphere.net/waddup.png?v1)


## Installation

Waddup is available from RubyGems and can be installed through the command-line.

Fire up your favourite terminal and run:

    gem install waddup

Installing on **OSX** and using the **default system Ruby**? Run:

    sudo gem install waddup


## Usage

Once installed, use the command `waddup` or its alias `sup` as follows:

    waddup with git and mail since last week until yesterday 23:00

Waddup is fairly liberal in what it accepts. The keywords described below may be mixed or ommitted as desired.


### Sources

At present, Waddup ships with three sources:

* Git `git`
* Apple Mail `mail`
* Apple Calendar `ical`

To specify one or multiple sources, use the `with`-keyword forming a regular sentence with the listed aliases:

    waddup with git
    waddup with git, mail and ical

When the `with`-keyword is ommitted it will default to all usable sources.


### Start date

To specify a start date, use either `from` or `since` as a keyword:

    waddup from october 29, 2013 9:00 AM
    waddup since last friday

Defaults to right now if a start date is ommitted. This default is likely to change in the future.

Dates/times are liberally parsed using [Chronic](https://github.com/mojombo/chronic). A grasp of crazy inputs one can use:

* yesterday
* last night
* last winter
* 3rd wednesday in november
* may seventh '97 at three in the morning


### End date

To specify an end date, use one of `to`, `until`, `uptil`, `upto` or `through`:

    waddup upto one week ago
    waddup through yesterday

Defaults to right now if an end date is ommitted.


### Formats

At present, Waddup supports two formats: visual (see screenshot) and JSON.

Use the `--format` flag to indicate the desired output format:

    waddup since yesterday --format json