Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dgsb/tt
sqlite based time tracking tool
https://github.com/dgsb/tt
sqlite timetracker timetracking
Last synced: about 1 month ago
JSON representation
sqlite based time tracking tool
- Host: GitHub
- URL: https://github.com/dgsb/tt
- Owner: dgsb
- License: mit
- Created: 2022-08-17T14:42:56.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-17T15:58:46.000Z (almost 1 year ago)
- Last Synced: 2024-06-20T09:22:17.858Z (5 months ago)
- Topics: sqlite, timetracker, timetracking
- Language: Go
- Homepage:
- Size: 153 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Time Tracker
## What is it ?
`tt` is a time tracking tools which uses an sqlite database as the data store.
The default database used is located in this file: `${HOME}/.tt.db`.
It has been mostly inspired by [timewarrior](https://timewarrior.net/).
The goal is to:
* have a simpler user interface
* get rid of the set of json file used to hold the data
* have a single data file instead.
* have a powerful query language for reports
## Building and installing
The build process is quite simple and only requires the golang compiler.
The repository needs to be cloned first and the binary can then be installed with the `go install` command
if the go compiler has been installed properly.
```
$ git clone github.com/dgsb/tt
$ cd tt
$ go install .
```
## Usage
The database file will be built upon the first command invocation.
### basic usage
* to start a time tracking activity
```
$ tt start
```
* to stop a time tracking activity
```
$ tt stop
```
* to list the current day activities
```
$ tt list
```
* to list the current week activities (from monday to sunday)
```
$ tt list :week
```
* to start a time tracking activity with tag
```
$ tt start developement
```
* to start a time tracking activity with multiple tags
```
$ tt start developement ticket-1234
```
* to get more help
```
$ tt --help
```
Most commands takes flags to alter the start or stop time instead
of merely using the current time.
An time tracking activity doesn't need to be closed before starting a new one.
The start command will automatically close the current opened tracking activity before opening a new one.
```
$ tt start development
$ tt start meeting
$ tt start qa
```
### Specifying the start and stop timestamp
`start` and `stop` subcommands have `--at` and `--ago` flags to allow to
specity the timestamp the command must use instead of merely using now.
The `--at` can take several format, it uses in this order the following format and stops as soon
as one matches:
* an RFC3339 formatted timestamp,
* an RFC3339 **without** the timezone part, the local host timezone is used
* a simple `hh:mm` format (24h wide hour)
If a format does not match it fallback on the next one.
The `--ago` specify a duration back in time from now to compute the timestamp.
This flag parameter can take anything that
[time.ParseDuration](https://pkg.go.dev/time#ParseDuration) understands
### Manually inspecting the database
The raw content of time tracking database can be accessed directly through the sqlite3 CLI.
```
sqlite3 ${HOME}/.tt.db
```