Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caarlos0/tasktimer
Task Timer (tt) is a dead simple TUI task timer
https://github.com/caarlos0/tasktimer
Last synced: 23 days ago
JSON representation
Task Timer (tt) is a dead simple TUI task timer
- Host: GitHub
- URL: https://github.com/caarlos0/tasktimer
- Owner: caarlos0
- License: mit
- Created: 2021-01-15T16:47:00.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T15:09:54.000Z (2 months ago)
- Last Synced: 2024-10-04T10:12:35.169Z (about 1 month ago)
- Language: Go
- Homepage:
- Size: 354 KB
- Stars: 406
- Watchers: 4
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- charm-in-the-wild - tasktimer - A dead-simple task timer. (_built with Bubble Tea_) (Applications / Productivity and Organization)
README
tasktimer
Task Timer (tt) is a dead simple TUI task timer.
---
## Usage
To get started, just run `tt`:
```sh
tt
```
You'll be presented with something like this:
You can just type a small description of what you're working on and press
ENTER to start timing.
At any time, press ENTER again to stop the
current timer or type a new task description and press ENTER
to stop the previous task and start the new one.
Each task will have its own timer, and the sum of all tasks will be displayed
in the header:
At any time, press CTRL+c to stop the current
timer (if any) and exit.
You can also press ESC stop the current task and blur the input
field and navigate around a long list of tasks using the
arrow keys/page up/page down/etc.
Note: there is no concept of "resuming tasks", you can however create several tasks with the same description.
## Report
You can extract a markdown file by running:
```sh
tt report
```
It will output the given project (via `-p PROJECT`) to `STDOUT`. You can
then save it to a file, pipe to another software or do whatever you like:
## Edit
Let's say you forgot the timer running... you can edit it using the edit command:
```sh
tt edit
```
The project will be exporter to a JSON file and will open with your `$EDITOR`.
Once you close it, it will be imported over the old one.
You can also backup/edit/restore using `tt to-json` and `tt from-json`.
## Help
At any time, check `--help` to see the available options.
## Install
**homebrew**:
```sh
brew install caarlos0/tap/tt
```
**apt**:
```sh
echo 'deb [trusted=yes] https://repo.caarlos0.dev/apt/ /' | sudo tee /etc/apt/sources.list.d/caarlos0.list
sudo apt update
sudo apt install tt
```
**yum**:
```sh
echo '[caarlos0]
name=caarlos0
baseurl=https://repo.caarlos0.dev/yum/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/caarlos0.repo
sudo yum install tt
```
**arch linux**:
```sh
yay -S tasktimer-bin
```
**deb/rpm/apk**:
Download the `.apk`, `.deb` or `.rpm` from the [releases page][releases] and install with the appropriate commands.
**manually**:
Download the pre-compiled binaries from the [releases page][releases] or clone the repo build from source.
## FAQ
### Where are data and logs stored?
Depends on the OS, but you can see yours running:
```sh
tt paths
```
## Stargazers over time
[](https://starchart.cc/caarlos0/tasktimer)
[Badger]: https://github.com/dgraph-io/badger
[releases]: https://github.com/caarlos0/tasktimer/releases
# Badges
[](https://github.com/caarlos0/tasktimer/releases/latest)
[](LICENSE.md)
[](https://github.com/caarlos0/tasktimer/actions?query=workflow%3Abuild)
[](https://goreportcard.com/report/github.com/caarlos0/tasktimer)
[](https://github.com/goreleaser)