timet

KO | EN

gitlite — search

#python #react #ai #typescript #golang #go #android #deep-learning #linux #nodejs #windows #awesome #awesome-list #openai

(★ 9)

Time tracker manager in terminal

timet Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Timet Logo](https://raw.githubusercontent.com/fabiorogeriosj/timet/master/img/logo.jpg)

Time tracker manager in terminal.

[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Linux Build][travis-image]][travis-url]
[![Windows Build][appveyor-image]][appveyor-url]
[![Test Coverage][coveralls-image]][coveralls-url]

## Install

```shell
npm install -g timet
```

![Timet Demo](https://raw.githubusercontent.com/fabiorogeriosj/timet/master/img/print.png)

## Using

Timet is only focused on helping you to record your work time on certain tasks via the terminal. The first time you run the timet, or try to register a new note, it will prompt you for some initial setup confirmations.

Its functionality is simple because schedules are stored in text files separated by date, you can store these files anywhere, or if you prefer, use a storage system in the cloud.

### New register

To register you need to send two parameters, first the time spent and then a description of the time spent:

```shell
timet 8h Created a new resource to do deploy referring to project task #34 ppline
```
```shell
timet 35m Checked infra of deploy
```
```shell
timet 4:45 Weekly planning meeting
```

Or you can enter the date you want to make the point:

```shell
timet 4/7/2017 8h Created a new resource to do deploy referring to project task #34 ppline
```
> Note: The format of the date you are going to inform will depend on the first setup you performed and configured, if you want to change the default settings, edit the timet.json file.

For each record you can use tags. Use at the end of the description @text.

```shell
timet 35m Meeting about git @project1 @teaching @test
```

### List registers

By default the timet lists the last 3 days of registration:

```shell
timet
```

You can list more days by entering the number of days to be listed:

```shell
timet 7
```

Or you can filter the result by passing two parameters with the start date and fnial date:

```shell
timet 2/20/2017 3/20/2017
```
> Note: The format of the date you are going to inform will depend on the first setup you performed and configured, if you want to change the default settings, edit the timet.json file.

You can generate an output in the txt file by passing the `--report` parameter:

```shell
timet 2/20/2017 3/20/2017 --report
```

### Remove register

To remove a register you need to enter the date and the register id:

```shell
timet remove 4/7/2017 7
```

### Integrations

Integrations are ideas for when you are recording a new note Time Tracker makes a launch in your management and project tool.

See the implemented tools and the configuration parameters:

| Name          | Configuration/Example |
| ------------- | ------------- |
| **Jira:**     | `timet --jira-login username:password --jira-host myjira.atlassian.net`  |
|               | For each record that has been entered the ticket ID will be registered in Jira as WorkLog: <br>`timet 1h Created a new action #PROJ-1021` |
| **Trello:**   | `timet --trello-key c478221b668 --trello-token 6a436593335320b048d2`  |
|               | For each record that has been entered the ID of the card will be recorded in Trello as a WorkLog comment: <br>`timet 1h Created a new action #Rp08U2wO` <br>For use integration with Trello you need generate a token and get your key for your user in: https://trello.com/app-key |

## Do you have suggestions for improvements?

We can not lose the focus that is to have a super simple and functional tool to record working hours in the terminal, if you have any idea of improvements that is in accordance with this directive open an issue and we will discuss about :)

## License

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/timet.svg
[npm-url]: https://npmjs.org/package/timet
[downloads-image]: https://img.shields.io/npm/dm/timet.svg
[downloads-url]: https://npmjs.org/package/timet
[travis-image]: https://img.shields.io/travis/fabiorogeriosj/timet/master.svg?label=linux
[travis-url]: https://travis-ci.org/fabiorogeriosj/timet
[appveyor-image]: https://img.shields.io/appveyor/ci/fabiorogeriosj/timet/master.svg?label=windows
[appveyor-url]: https://ci.appveyor.com/project/fabiorogeriosj/timet
[coveralls-image]: https://img.shields.io/coveralls/fabiorogeriosj/timet/master.svg
[coveralls-url]: https://coveralls.io/r/fabiorogeriosj/timet?branch=master

timet

timet Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

timet

timet Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README