Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/meeDamian/toggl-cli

Manage your Toggl.com time entries from the familiarity of the nearby CLI.
https://github.com/meeDamian/toggl-cli

Last synced: 3 months ago
JSON representation

Manage your Toggl.com time entries from the familiarity of the nearby CLI.

Awesome Lists containing this project

README

        

# toggl-cli
[![Build Status](https://travis-ci.org/meeDamian/toggl-cli.svg?branch=master)](https://travis-ci.org/meeDamian/toggl-cli) [ ![Codeship Status for meeDamian/toggl-cli](https://codeship.com/projects/4651ffa0-ae14-0133-e229-0eeab60c84ba/status?branch=master)](https://codeship.com/projects/132211) [![Coverage Status](https://coveralls.io/repos/github/meeDamian/toggl-cli/badge.svg?branch=master)](https://coveralls.io/github/meeDamian/toggl-cli?branch=master) [![codecov.io](https://codecov.io/github/meeDamian/toggl-cli/coverage.svg?branch=master)](https://codecov.io/github/meeDamian/toggl-cli?branch=master) [![npm version](https://badge.fury.io/js/toggl-cli.svg)](https://badge.fury.io/js/toggl-cli) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) [![Dependency Status](https://david-dm.org/meeDamian/toggl-cli.svg)](https://david-dm.org/meeDamian/toggl-cli) [![devDependency Status](https://david-dm.org/meeDamian/toggl-cli/dev-status.svg)](https://david-dm.org/meeDamian/toggl-cli#info=devDependencies)

Manage your Toggl.com time entries from the familiarity of the nearby CLI.

## Download (node v5.0+)

```
$ npm install -g toggl-cli
```

## Usage (Simple)

![Simple Mode demo](/gifs/simple.gif)

```
$ toggl --help

Manage your Toggl.com time entries from the familiarity of the nearby CLI.

Usage:
Interactive mode:
$ toggl

Single request:
$ toggl

Flags:
-v --version - output version
-h --help - output this help
--examples - show usage examples
--no-colors - disable colors
--save-token - save provided token and exit
-t --token - run with a custom token (will not be saved)
--set-background - set color theme. Choose more readible: dark or light

Commands:
c current - see details of currently running time entry (if any).
l list [amount|when] - list last of time entries (default: 8) or (see below)
s smart [name|number] - start or stop the entry, whatever makes more sense.
start [name|number] - start new time entry with the given name, or resume if number is given.
stop - stop running entry.
r rename - rename currently running entry to .
b browser - open Toggl timer in default browser.

Note:
→ Values in [square brackets] are optional.
→ is one of:
today, yesterday, last Monday, last tue, etc…

$ toggl --examples

Set default token for all future launches:
$ toggl --save-token d9db051bf06be16c2027d3cb08769451

List last 17 time entries for a different account:
$ toggl --token a1ad615af03be16c2027d3dc08291457 list 17

Run interactive mode with a different token:
$ toggl --token a1ad615af03be16c2027d3dc08291457

Start a new task named "Writing toggl-cli docs":
$ toggl start Writing toggl-cli docs

Resume last running time entry:
$ toggl start 1

List entries from the last Friday:
$ toggl list last friday

Alias toggl for work:
$ echo "toggl2='toggl --token '" >> ~/.bashrc
$ toggl list yesterday # yesterday entries from your private account
$ toggl2 list # last 8 entries from your work account

$ toggl --logo

NN
.: NN :.
cX0l NN l0Nc
xM; NN ;Mx
WK OO KW
oMc cMo
;0Xd:,,:dX0;
.xNMMNx.
```

## Usage (Interactive)

![Interactive Mode demo](/gifs/interactive.gif)

```
Time entry
c ⇾ current 1-9 ⇾ resume from the list
s ⇾ start or stop r ⇾ rename l ⇾ list last 8
d ⇾ discard p ⇾ add project L ⇾ list last 16

Other
x ⇾ clear h, ? ⇾ help v ⇾ version
b ⇾ open in browser q ⇾ quit

What do you want to do [c,1-9,s,r,d,p,l,L,b,v,h,?,q]?
```

## Notice

* This module is in no way supported nor developed by Toggl.com .
* It's still WIP, any and all PRs highly appreciated (esp. tests ☺)

## Bugs and feedback

If you discover a bug please report it [here](https://github.com/meeDamian/toggl-cli/issues/new).

Mail me at [email protected], or on twitter [@meeDamian](http://twitter.com/meedamian).

![codecov.io](https://codecov.io/github/meeDamian/toggl-cli/branch.svg?branch=master)

## License

MIT @ [Damian Mee](https://meedamian.com)