Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhth/hours
A no-frills time tracking toolkit for command line nerds
https://github.com/dhth/hours
time-tracker time-tracking tui
Last synced: 10 days ago
JSON representation
A no-frills time tracking toolkit for command line nerds
- Host: GitHub
- URL: https://github.com/dhth/hours
- Owner: dhth
- License: mit
- Created: 2024-06-09T13:33:49.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T11:43:17.000Z (4 months ago)
- Last Synced: 2024-07-22T13:59:29.956Z (4 months ago)
- Topics: time-tracker, time-tracking, tui
- Language: Go
- Homepage: https://tools.dhruvs.space/hours
- Size: 251 KB
- Stars: 96
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- charm-in-the-wild - hours - A no-frills time tracking toolkit for the command line. (_built with Bubble Tea_) (Applications / Productivity and Organization)
- awesome-repositories - dhth/hours - A no-frills time tracking toolkit for command line nerds (Go)
README
# hours
`hours` is a no-frills time tracking toolkit for the command line.
It's designed for users who want basic time tracking for their tasks/projects
right in the terminal. With a simple and minimalistic UI, almost everything in
`hours` can be achieved with one or two keypresses. It can also generate
plaintext reports, summary statistics, and logs based on time tracked.
[Link to Video][2]
🤔 Motivation
---
For a while, I've been wanting to keep track of time I spend on side projects
and other non-day-job activities. I also wanted to be able to generate plain
text reports to get an overview of time allocation. All of this needed to be
done via a fast command line tool that prioritised ease of use over
fancy-but-ultimately-not-so-useful features. I couldn't find a tool that
precisely fit these needs, so I decided to build one for myself.
💾 Install
---
**homebrew**:
```sh
brew install dhth/tap/hours
```
**go**:
```sh
go install github.com/dhth/hours@latest
```
Or get the binaries directly from a
[release](https://github.com/dhth/hours/releases).
⚡️ Usage
---
> Newbie tip: If you want to see how `hours` works without having to track time,
> you can have it generate dummy data for you. See [here](#generate-dummy-data)
> for more details.
### TUI
Open the TUI by simply running `hours`. The TUI lets you do the following:
- create/update tasks
- start/stop tracking time on a task
- add manual task log entries
- deactivate/activate a task
- view historical task log entries
Besides a TUI, `hours` also offers reports, statistics, and logs based on the
time tracking you do. These can be viewed using the subcommands `report`,
`stats`, and `log` respectively.
### Reports
```bash
hours report [flags] [arg]
```
Output a report based on task log entries.
Reports show time spent on tasks per day in the time period you specify. These
can also be aggregated (using `-a`) to consolidate all task entries and show the
cumulative time spent on each task per day.
Accepts an argument, which can be one of the following:
today: for today's report
yest: for yesterday's report
3d: for a report on the last 3 days (default)
week: for a report on the current week
date: for a report for a specific date (eg. "2024/06/08")
range: for a report for a date range (eg. "2024/06/08...2024/06/12")
*Note: If a task log continues past midnight in your local timezone, it will be
reported on the day it ends.*
Reports can also be viewed via an interactive interface using the
`--interactive`/`-i` flag.
### Log
```bash
hours log [flags] [arg]
```
Output task log entries.
Accepts an argument, which can be one of the following:
today: for log entries from today (default)
yest: for log entries from yesterday
3d: for log entries from the last 3 days
week: for log entries from the current week
date: for log entries from a specific date (eg. "2024/06/08")
range: for log entries from a specific date range (eg. "2024/06/08...2024/06/12")
*Note: If a task log continues past midnight in your local timezone, it'll
appear in the log for the day it ends.*
Logs can also be viewed via an interactive interface using the
`--interactive`/`-i` flag.
### Statistics
```bash
hours stats [flag] [arg]
```
Output statistics for tracked time.
Accepts an argument, which can be one of the following:
today: show stats for today
yest: show stats for yesterday
3d: show stats for the last 3 days (default)
week: show stats for the current week
date: show stats for a specific date (eg. "2024/06/08")
range: show stats for a specific date range (eg. "2024/06/08...2024/06/12")
all: show stats for all log entries
*Note: If a task log continues past midnight in your local timezone, it'll
be considered in the stats for the day it ends.*
Stats can also be viewed via an interactive interface using the
`--interactive`/`-i` flag.
### Active Task
`hours` can show you the task being actively tracked using the `active`
subcommand. This subcommand supports the following placeholders using the
`--template`/`-t` flag:
{{task}}: for the task summary
{{time}}: for the time spent so far on the active log entry
Tip: This can be used to display the active task in tmux's (or similar terminal
multiplexers) status line using:
```
set -g status-right "#(hours active -t ' {{task}} ({{time}}) ')".
```
### Generate Dummy Data
You can have `hours` generate dummy data for you, so you can play around with
it, and see if its approach of showing reports/logs/stats works for you. You can
do so using the `gen` subcommand.
```bash
hours gen --dbpath=/var/tmp/throwaway.db
```
📋 TUI Reference Manual
---
```text
"hours" has 6 views:
- Tasks List View Shows active tasks
- Task Management View Shows a form to create/update tasks
- Task Logs List View Shows your task logs
- Inactive Tasks List View Shows inactive tasks
- Task Log Entry View Shows a form to save/update a task log entry
- Help View
Keyboard Shortcuts
General
1 Switch to Tasks List View
2 Switch to Task Logs List View
3 Switch to Inactive Tasks List View
Go to next view/form entry
Go to previous view/form entry
? Show help view
General List Controls
k/ Move cursor up
j/ Move cursor down
h Go to previous page
l Go to next page
Refresh list
Task List View
a Add a task
u Update task details
s Toggle recording time on the currently selected task,
will open up a form to record a task log entry on
the second "s" keypress
Edit the currently active task log/Add a new manual task log entry
Go to currently tracked item
Deactivate task
Task Logs List View
Delete task log entry
Refresh list
Inactive Task List View
Activate task
Task Log Entry View
enter Save task log entry
k Move timestamp backwards by one minute
j Move timestamp forwards by one minute
K Move timestamp backwards by five minutes
J Move timestamp forwards by five minutes
```
Acknowledgements
---
`hours` is built using [bubbletea][1], and is released using [goreleaser][2],
both of which are amazing tools.
[1]: https://github.com/charmbracelet/bubbletea
[2]: https://github.com/goreleaser/goreleaser