Expand description
A Pomodoro CLI and library
Manages a set of files that describe the current Pomodoro or break, as well as a history of completed Pomodoros.
All the interface functions in this module require a Config struct.
Check out that struct’s documentation for default values and functions
for loading and saving a configuration.
Structs§
- Config
- Global configuration values
- History
- A record of past Pomodoro timers
- Pomodoro
- A Pomodoro timer
- Timer
- Like a kitchen timer
Enums§
- Status
- Phases of the Pomodoro technique
Functions§
- clear
- Clear the current state by deleting the state file
- default_
config_ path - Get the default location of the config file
- finish
- Finish and archive a Pomodoro or break timer
- purge
- Delete the state and history files
- start
- Start a Pomodoro timer
- take_
long_ break - Start a long break timer
- take_
short_ break - Start a short break timer