https://github.com/gochrono/chrono
A fast time tracking tool made with love
https://github.com/gochrono/chrono
chrono cli go golang linux linux-cli time-tracker
Last synced: 4 months ago
JSON representation
A fast time tracking tool made with love
- Host: GitHub
- URL: https://github.com/gochrono/chrono
- Owner: gochrono
- License: mit
- Created: 2018-10-08T18:42:42.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-03-25T22:30:55.000Z (over 4 years ago)
- Last Synced: 2024-06-19T02:09:26.081Z (over 1 year ago)
- Topics: chrono, cli, go, golang, linux, linux-cli, time-tracker
- Language: Go
- Size: 489 KB
- Stars: 32
- Watchers: 2
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-time-tracking - Chrono - Chrono is a fast, Go-based time tracking tool with a simple interface, suitable for users who need efficient and straightforward time logging. ([Read more](/details/chrono.md)) `open-source` `command-line` `go` `simple` (Time Tracking CLI Tools)
README
[](https://github.com/gochrono/chrono/releases)
[](https://goreportcard.com/report/github.com/gochrono/chrono)
[](https://travis-ci.org/gochrono/chrono)
## Overview ##
Chrono is a time tracking tool written in Go.
It is fast and simple to use.
Want to know what you did with your time? Chrono will help you with that. Track how
long you spend on a project. Add notes so you know exactly what
you did.
[](https://asciinema.org/a/pb5PlJHshi2gjpDeQYCj0gmfI)
## Installation ##
### Binaries Releases ###
To install the latest stable release:
``` bash
curl -L https://git.io/fpHAj | sh
```
We provide pre-built Chrono binaries for Windows, Linux, and macOS (Darwin) for x64 and i386 architectures.
If you'd like to install a specific version, checkout the [releases page](https://github.com/gochrono/chrono/releases).
If you want to run the absolute latest version, [build it from source](#building-chrono-from-the-source).
### Package Managers ###
If you are using __Arch Linux__, you can install the AUR package [chrono-git][2] to get the latest version or [chrono][3] for the latest stable release.
If you're using __Ubuntu__ or a __Debian__ based system, you can find debian packages (.deb) on the [releases page](https://github.com/gochrono/chrono/releases).
## Quickstart ##
### Usage ###
To start tracking time a project, use the `start` command:
``` bash
$ chrono start development +chrono
```
If you wanted to set the start time to something other than now, use the '--start' flag:
``` bash
$ chrono start development --at "2019-02-01 13:00"
```
Time is parsed by [jinzhu/now][now] so it should be in a format it can understand.
This creates a new __frame__ for the development project with the chrono tag.
Keep notes of what you do for a project with the `notes add` command:
``` bash
$ chrono notes add "made some awesome changes to the README"
$ chrono notes show
[0]: made some awesome changes to the README
```
The notes are added to the current __frame__.
Get information about the current frame with the `status` command:
``` bash
$ chrono status
Project development [chrono] started 10 seconds ago.
```
To stop tracking time for the current frame, use the `stop` command:
``` bash
$ chrono stop
Stopping project development [chrono], started 5 minutes ago (id: 073bbf).
```
You can show a chronolical list of the current day's session (or __frames__) through the `log` command:
``` bash
$ chrono log
Monday 3 December 2018
(ID: 0d3131) 10:15 to 10:20 0h 05m 00s development [chrono]
```
For a list of all available commands, use the `help` command:
```
$ chrono help
```
For a list of all available options and arguments for a command, use the `---help` flag:
```
$ chrono log --help
```
## Building Chrono from the Source ##
### Prequisite Tools ###
* [Git](https://git-scm.com/)
* [Go (at least Go 1.11)](https://golang.org/dl/)
### Downloading & building the source ###
Chrono uses [Go Modules](https://github.com/golang/go/wiki/Modules) to handle dependencies.
The easiest way to build from the source is to clone Chrono in a directory outsite of `GOPATH`, for example:
``` bash
mkdir ~/src && cd ~/src
git clone https://github.com/gochrono/chrono.git
cd chrono
go install
```
Make sure `$GOPATH/bin` is on `$PATH`.
If you haven't customized your `$GOPATH` then you'll need to add `~/go/bin` to `$PATH`.
## Contributing to Chrono ###
To contribute to the Chrono project or documentation, you should [fork the GitHub project](https://github.com/gochrono/chrono#fork-destination-box) and clone it to your machine.
For a complete guide to contributing to Chrono, see the [Contribution Guide](CONTRIBUTING.md).
We welcome contributions of many kinds from updating documentation, feature requests, bug reports & issues,
feature implementation, pull requests, answering other users questions, etc.
### Asking Support Questions ###
We currently don't have a discussion forum. For now, use the issue tracker to ask questions.
### Reporting Issues ###
If you believe you have found an issue or bad documentation, use
the GitHub issue tracker to report the problem to the Chrono maintainers.
When reporting an issue, please provide the version of chrono is use (`chrono version`)
[now]: https://github.com/jinzhu/now#parse-string-to-time
[1]: https://asciinema.org/a/pb5PlJHshi2gjpDeQYCj0gmfI
[2]: https://aur.archlinux.org/packages/chrono-git/
[3]: https://aur.archlinux.org/packages/chrono/