Skip to content

Latest commit

 

History

History
142 lines (104 loc) · 3.94 KB

README.md

File metadata and controls

142 lines (104 loc) · 3.94 KB
Raw

⏳ trackie

Crates.io Crates.io GitHub Workflow Status

`trackie` is a private, daemon-less time tracker running in your CLI.

Trackie offers an easy CLI to track the time you spent on your various projects. It bundles up your busy days in easy digestible reports that you can filter to your liking.

All data is saved to ($XDG_DATA_HOME|%APPDATA%)/trackie/trackie.json where it can be processed by other tools.

Trackie is optimized to lower its complexity to the absolute minimum.

Usage

Trackie currently consists of three simple commands:

  • trackie start <project-ID>: Starts time tracking for a project with the given ID.
  • trackie stop: Stops the time tracking.
  • trackie resume: Resumes time tracking for the last tracked project.
  • trackie status [-f <format>]: Prints information about the currently tracked project.
  • trackie report [-d <num-days>] [-i/--include-empty-days] [--json]: Creates a report for the last n days (default: 5).

Shell integration

Trackie's customizable status command is a great fit for many shells.

Starship

The following starship configuration, for example, leads to a nice element that shows on which project you are working on and for how long you are already doing that.

[custom.trackie]
command = 'trackie status -f "%p[%D]"'
# Comment the following line if you don't want to hide the trackie block if no project is currently tracked
when = "trackie status"
symbol = "⏳"
style = "bg:cyan fg:black"
format = "[$symbol($output)]($style)[](fg:cyan)"

This configuration leads to the following result:

Windows Terminal with starship and trackie extension
Use the following config to get better performance when using powershell 
[custom.trackie]
command = ''
shell = ["cmd.exe", "/C", "trackie status -f %p[%D]"]
# Comment the following line if you don't want to hide the trackie block if no project is currently tracked
when = "trackie status"
symbol = "⏳"
style = "bg:cyan fg:black"
format = "[$symbol($output)]($style)[](fg:cyan)"

Oh My Posh

To get an equivalent prompt with "Oh my Posh", use the following segement code in your config file.

{
  "type": "command",
  "style": "powerline",
  "foreground": "#100e23",
  "powerline_symbol": "\uE0B0",
  "background": "cyan",
  "properties": {
    "prefix": "⏳",
    "command": "/root/trackie status -f %p[%D]"
  }
}

Completion

Use the completion command to generate the completion script for your shell. See trackie completion --help for details.

Exemple with zsh:

trackie completion zsh > /usr/local/share/zsh/site-functions/_trackie

Note Make sure to restart your shell for the changes to take effect

Installation

Download prebuilt release

  1. Download the binary for your respective OS from the latest release.
  2. Copy it to a folder in your PATH.

Compile from source using cargo

  1. Run cargo install trackie.

Compile from source using make

git clone https://github.com/beatbrot/trackie
cd trackie
make
sudo make install