KW-POMODORO(1)

πŸ“¦ version 0.10, in ubuntu stonking

πŸ… kw-pomodoro, bestie πŸ’–

okay so this is the manual for kw-pomodoro β€” the kw man page that's all about creating and managing Pomodoro timers. Yes, the whole "focus for 25 minutes, then vibe" technique, but as a command. It's giving "kernel dev but make it cute". ✨


✨ SYNTAX (SYNOPSIS) ✨

like, here's literally every shape this command can take, copy-paste ready:

kw (p | pomodoro) (-t | --set-timer) <time>(h | m | s) [(-g | --tag) <tag> [(-d | --description) <desc>] [--verbose]]
kw (p | pomodoro) (-c | --check-timer) [--verbose]
kw (p | pomodoro) (-s | --show-tags) [--verbose]
kw (p | pomodoro) (--repeat-previous) [--verbose]

so p is just pomodoro being lazy, iconic of it honestly πŸ’…


🌸 DESCRIPTION 🌸

so basically, this feature exists so kernel developers can manage their time with the Pomodoro technique. timeboxing but make it ✨structured✨.

okay and the star of the show here is the --tag / -g option, because it lets you slap a lil tag onto your timebox. then later you can generate a report that shows your focus time per tag. obsessed. registering a tag is literally just kw pomodoro --tag <name>, and heads up bestie: the maximum length for this tag is 32 characters. don't be doing too much.

optionally (optional means optional, but hear me out) you can add an extra layer of detail by giving a tag a description with --description / -d. the recommendation is to use this option with the same tag and update the description every time you work on a specific task β€” and with that, kw can generate a fine-grained report within a set of descriptions shown nested under a particular tag. nesting. we love to see it. πŸͺ†

naturally 😭 you're gonna forget which tag name you registered for a specific task, because of course you will. so to help, there's kw pomodoro --show-tags, which shows you all the tags you registered β€” and the output also gives you the tag's ID. so helpful of it tbh.

πŸ’€ Note: It is highly recommended to use tags and descriptions with a timebox. like fr fr, do it.

πŸŽ€ OPTIONS πŸŽ€

  • -t <time>(h | m | s), --set-timer <time>(h | m | s) β€” this one wants an integer <time> that says how long the Pomodoro timebox is. you must add a suffix telling it the unit, and the options are h (hour), m (minutes), or s (seconds). mandatory suffix. no suffix, no timer, no slay. ⏰
  • -g <tag>, --tag <tag> β€” associates a tag with the timebox. and here's the cute part: if <tag> is an integer, kw will try to match it against an existing tag ID and translate it to the matching tag name. this option needs to be used together with --set-timer β€” they're a package deal.
  • -d <desc>, --description <desc> β€” gives you space for more descriptive text attached to the timer. max length is 512 characters, and this option needs --tag and --set-timer alongside it. it does not fly solo.
  • -c, --check-timer β€” shows you the info associated with each active Pomodoro timebox. spy on your own productivity, queen. πŸ‘‘
  • -s, --show-tags β€” shows all the registered tags. all of them. the whole tag fam. 🏷️
  • --repeat-previous β€” repeats the last Pomodoro session, with the same tag name and description (if applicable). because sometimes you just want a rerun, no cap. πŸ”
  • --verbose β€” displays the commands executed under the hood. iykyk β€” it's the "show your work" mode. πŸ”

πŸ¦‹ EXAMPLES πŸ¦‹

Create a Pomodoro timebox of 10 minutes without tags:

kw pomodoro --set-timer 10m

Show active Pomodoro timeboxes:

kw pomodoro --check-timer

Show all registered tags:

kw pomodoro --show-tags

Create a Pomodoro timebox of 1 hour with tag name 'kernel-dev' and description 'amd-gfx patch reviews':

kw pomodoro --set-timer 1h --tag 'kernel-dev' --description 'amd-gfx patch reviews'

To repeat that last Pomodoro session:

kw pomodoro --repeat-previous

Create a Pomodoro timebox of 99 seconds with tag name corresponding to the tag of ID 42:

kw pomodoro --set-timer 99s --tag 'kernel-dev

and that's the whole page bestie β€” go forth, set a timer, tag it, and get that focus time bestie πŸ’–πŸ“βœ¨

this was the kw-pomodoro manual β€” "Create and manage Pomodoro timers" β€” and yeah that lil footer slash title font action up top says the same thing twice, it's just the page name and the section it lives in. consider yourself informed. 🫢

πŸ“¦ where this page comes from