Skip to content

An nCurses based application for logging time to Jira tickets. Because time logging has far too much friction and I get in far too much trouble for not doing it.

Notifications You must be signed in to change notification settings

BeesBoxler/jogger

Repository files navigation

Jogger 🏃🏼‍♀️

An nCurses based application for logging time to Jira tickets. Because time logging has far too much friction and I get in far too much trouble for not doing it. Jogger

Installation

Quick Install (Recommended)

# Install via cargo-binstall (fast, uses pre-built binaries)
cargo binstall jogger

# Or install from source
cargo install jogger

From Source

This package relies on ncurses and therefore probably only works on Windows under WSL.

Ubuntu/Debian:

sudo apt install -y build-essential pkg-config libssl-dev libncurses5-dev libncursesw5-dev
cargo install jogger

macOS:

# For the menu bar app (Gerald the Gentleman Runner!)
cargo install jogger-macos

# Or for the TUI
cargo install jogger

First Time Setup

The first time you use this app you will be requred to set four parameters.

  • Your Name (Optional)
  • Your personal distraction ticket
    • Not every organisation uses this, ignore it if it doesn't apply to you
  • Your Personal Access Token from Jira
    • This can be found in Profile > Personal Access Token
  • Jira URL
    • This is the base URL you use when visiting JIRA
    • ie. https://jira.company.com/

Once saved, these parameters will be stored for future usage.

Roadmap

  • Being able to customise the Category and Actions presented on the logging screen
  • Being able to set a custom date
  • Remove Category and Action from the logging screen
  • Make it look less like ****
  • Distributed binaries

Auto-Start at Login (macOS)

To have Jogger start automatically when you log in:

# First, install the binary
cargo install --path jogger-macos

# Then run the install script
./install-launchagent.sh

This creates a LaunchAgent that starts Jogger in the background at login.

To uninstall:

launchctl unload ~/Library/LaunchAgents/com.jogger.macos.plist
rm ~/Library/LaunchAgents/com.jogger.macos.plist

🖤

About

An nCurses based application for logging time to Jira tickets. Because time logging has far too much friction and I get in far too much trouble for not doing it.

Resources

Stars

Watchers

Forks