Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/strangedev/worktimer
Timer application that tracks active time in X11
https://github.com/strangedev/worktimer
cli-app command-line-tool linux linux-desktop productivity time-tracker x11
Last synced: about 2 months ago
JSON representation
Timer application that tracks active time in X11
- Host: GitHub
- URL: https://github.com/strangedev/worktimer
- Owner: strangedev
- Created: 2022-05-09T18:16:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-21T18:36:38.000Z (over 2 years ago)
- Last Synced: 2024-10-13T08:22:47.093Z (3 months ago)
- Topics: cli-app, command-line-tool, linux, linux-desktop, productivity, time-tracker, x11
- Language: Go
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# worktimer
`worktimer` records active hours in X11 to make writing time sheets less of a pain in the ass.
Runs on Linux with X11 only.
## Building
You need to have the X11 libs installed.
```shell
make
```
## Installing
Build from source or download the binary first.
```shell
sudo make install
```
## Running
Build from source or download the binary first.
```
make redeploy-service
```
Alternatively, grab the service file from the release section and start it manually.
## Commands
Use `worktimer help` to view the help. Use `worktimer help [COMMAND]` to view the help for any command.
These are the most commonly used commands:
```shell
worktimer start # Starts recording times
worktimer stop # Stops recording times
worktimer note "Some text" # Records a note in the current time slice so you know what you did at that time
worktimer status # Prints the status of the timer
worktimer report YYYY-MM-DD # Outputs stats for a given day
```
## How it works
When the timer is started, it records times to `${HOME}/.config/worktimer` in JSON format.
The times are recorded in the form of time slices:
```json5
[
{
"Started": "2022-05-09T20:09:58.753476314+02:00",
"Ended": "2022-05-09T20:10:02.008421633+02:00",
"Duration": 3254945309,
"Notes": null,
"StartedBy": "Manual start",
"EndedBy": "X11 idle"
},
{
"Started": "2022-05-09T20:10:36.579078677+02:00",
"Ended": "2022-05-09T20:11:51.624152165+02:00",
"Duration": 75045073468,
"Notes": null,
"StartedBy": "X11 activity",
"EndedBy": "X11 idle"
},
{
"Started": "2022-05-09T20:11:52.997820441+02:00",
"Ended": "2022-05-09T20:11:55.20356786+02:00",
"Duration": 2205747419,
"Notes": [
"Did a thing"
],
"StartedBy": "Note added",
"EndedBy": "Manual stop"
}
]
```
Each time the timer is stopped by the user or the user is inactive for 5 minutes, a time slice is recorded.
Inactivity is interrupted by using X11 (i.e. moving your mouse or typing) or by adding notes.
The daemon writes the current times to disk every hour, or when it shuts down.