# Doug [![CircleCI](https://circleci.com/gh/getdoug/doug.svg?style=svg)](https://circleci.com/gh/getdoug/doug) [![cargo-badge](https://img.shields.io/crates/v/doug.svg)](https://crates.io/crates/doug)
> A time tracking command-line utility

## Why?

To have a time tracker that's not inhibited by [slow language startup times][0].

## Install

[brew][1]

```
brew install getdoug/doug/doug
```

[cargo][2]

```
cargo install doug
```

### Bash completions
```
doug generate-completions --shell bash > $(brew --prefix)/etc/bash_completion.d/doug.bash
```

## Usage
```
USAGE:
    doug [FLAGS] <SUBCOMMAND>

FLAGS:
    -p, --path       Path to load settings file from. (default: ~/.doug/settings.json)
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    start                   Track new or existing project
    status                  Display elapsed time, start time, and running project name
    stop                    Stop any running projects
    cancel                  Stop running project and remove most recent time interval
    restart                 Track last running project
    log                     Display time intervals across all projects
    report                  Display aggregate time from projects
    amend                   Change name of currently running project
    edit                    Edit last frame or currently running frame
    settings                configure doug settings
    generate-completions    Generate completions
    delete                  Delete all intervals for project
```

### start
```
Track new or existing project

USAGE:
    doug start <project>

FLAGS:
    -h, --help    Prints help information

ARGS:
    <project>    project to track
```
### status
```
Display elapsed time, start time, and running project name

USAGE:
    doug status [FLAGS]

FLAGS:
    -h, --help      Prints help information
    -s, --simple    Print running project name or nothing if there isn't a running project.
```
### stop
```
Stop any running projects

USAGE:
    doug stop

FLAGS:
    -h, --help    Prints help information
```
### cancel
```
Stop running project and remove most recent time interval

USAGE:
    doug cancel

FLAGS:
    -h, --help    Prints help information
```
### restart
```
Track last running project

USAGE:
    doug restart

FLAGS:
    -h, --help    Prints help information
```
### log
```
Display time intervals across all projects

USAGE:
    doug log

FLAGS:
    -h, --help    Prints help information
```
### report
```
Display aggregate time from projects

USAGE:
    doug report [FLAGS] [OPTIONS]

FLAGS:
    -d, --day      Limit report to past day. Use multiple to increase interval.
    -h, --help     Prints help information
    -m, --month    Limit report to past month. Use multiple to increase interval.
    -w, --week     Limit report to past week. Use multiple to increase interval.
    -y, --year     Limit report to past year. Use multiple to increase interval.

OPTIONS:
    -f, --from <from>    Date when report should start (e.g. 2018-1-1)
    -t, --to <to>        Date when report should end (e.g. 2018-1-20)
```
### amend
```
Change name of currently running project

USAGE:
    doug amend <project>

FLAGS:
    -h, --help    Prints help information

ARGS:
    <project>    new project name
```
### edit
```
Edit last frame or currently running frame

USAGE:
    doug edit [OPTIONS]

FLAGS:
    -h, --help    Prints help information

OPTIONS:
    -e, --end <end>        ending date
    -s, --start <start>    starting date
```
### settings
```
configure doug settings

USAGE:
    doug settings [FLAGS] [OPTIONS]

FLAGS:
    -c, --clear    
            clear settings file

    -h, --help     
            Prints help information


OPTIONS:
    -p, --path <path>    
            path to store data file. this only affects the data file location. settings are stored in $HOME.
```
### delete
```
Delete all intervals for project

USAGE:
    doug delete <project>

FLAGS:
    -h, --help    Prints help information

ARGS:
    <project>    new project name
```
### merge
```
Merge period files

USAGE:
    doug merge [FLAGS] <file>

FLAGS:
        --dry-run    don't modify period file
    -h, --help       Prints help information

ARGS:
    <file>    path to period file to merge
```

## Prior Art

- <http://wtime.sourceforge.net>
- <https://github.com/TailorDev/Watson>
- <https://github.com/danibram/time-tracker-cli>
- <https://github.com/samg/timetrap>

[0]: https://mail.python.org/pipermail/python-dev/2017-July/148656.html
[1]: https://brew.sh
[2]: http://doc.crates.io