decafe-timer 0.5.2

CLI coffee cooldown timer with a shrinking ASCII bar.

decafe-timer

---

Table of Contents

• Installation
• Usage
• License

Installation

pipx install decafe-timer

Usage

The CLI revolves around three ideas:

1. Passing a duration creates a new cooldown; omitting it resumes whatever is already running. You can use single durations (2h, 15m30s, 0:45:00) or a remaining/total pair like 3h/5h (spaces around / are allowed, and mixed formats like 3h/4:50:00 work too).
2. --run decides whether to keep the live UI updating until the cooldown expires. Without --run, the command prints the current status once and exits.
3. Style flags pick the ASCII layout and ANSI behavior.
   • Layout output:
     • Default is multi-line (Remaining / Expires at + bar).
     • --one-line uses HH:MM:SS ✕ ✕ ✕ ….
     • --graph-only prints just the bar.
   • Bar characters:
     • --bar-style swaps the bar characters (greek-cross default, counting-rod, or blocks for the previous look).
   • ANSI output:
     • ANSI is auto-enabled on TTYs.
     • --color=always forces ANSI on; --color=never forces it off (applies to both live and snapshot output).
   • Live updates:
     • When paired with --run, the live updates use the same ASCII bar (colored via ANSI).
   • Snapshot finish:
     • Snapshots print [You may drink coffee now.] once the timer finishes.

decafe-timer 45m          # start a new timer, print one snapshot
decafe-timer 3h/5h        # start with 3h remaining out of a 5h total
decafe-timer              # resume the latest timer, one snapshot
decafe-timer --run 45m    # start a new timer and watch it count down
decafe-timer --run        # resume the live UI for an active timer
decafe-timer --run --one-line 10m  # live ASCII updates on one line
decafe-timer --bar-style blocks   # use the classic block bar
decafe-timer --bar-style counting-rod  # use the counting rod bar
decafe-timer --graph-only # snapshot with the ASCII bar only
decafe-timer --version    # show the current version

License

decafe-timer is distributed under the terms of the MIT license.