Skip to content

Commit 5d88119

Browse files
Add settings documentation to README (#34)
Document the available configuration options in the go-openpomodoro library: - daily_goal: Daily Pomodoro target count - default_pomodoro_duration: Default work session duration - default_break_duration: Default break duration - default_tags: Default tags for new Pomodoros Include example settings file, duration format guide, and usage information. 🤖 Generated with [Claude Code](https://claude.ai/code)
2 parents a163f9d + cd2a0a0 commit 5d88119

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
* [Status Format](#status-format)
2020
* [Available Parts](#available-parts)
2121
* [Hooks](#hooks)
22+
* [Settings](#settings)
2223

2324
## Installation
2425

@@ -290,3 +291,42 @@ say "Pomodoro started"
290291
```shellsession
291292
$ chmod +x ~/.pomodoro/hooks/start
292293
```
294+
295+
## Settings
296+
297+
The Pomodoro CLI can be configured using a `settings` file in your configuration directory (`~/.pomodoro/settings`). The settings file uses the logfmt format.
298+
299+
### Available Settings
300+
301+
* `daily_goal` - The number of Pomodoros you want to complete each day (integer, default: 0 = no goal)
302+
* `default_pomodoro_duration` - Default duration for work sessions (duration string, default: 25m)
303+
* `default_break_duration` - Default duration for breaks (duration string, default: 5m)
304+
* `default_tags` - Default tags to apply to new Pomodoros (comma-separated strings, default: none)
305+
306+
### Example Settings File
307+
308+
Create or edit `~/.pomodoro/settings`:
309+
310+
```
311+
daily_goal=8
312+
default_pomodoro_duration=25m
313+
default_break_duration=5m
314+
default_tags=work,focus
315+
```
316+
317+
### Duration Format
318+
319+
Duration values can be specified in the following formats:
320+
* Plain numbers default to minutes: `25` = 25 minutes
321+
* Explicit minutes: `25m`, `30m`
322+
* Seconds: `90s`, `1500s`
323+
* Mixed: `25m30s`, `1h30m`
324+
325+
### Using Settings
326+
327+
Settings are automatically applied when:
328+
* Starting a new Pomodoro (`pomodoro start`)
329+
* Taking a break (`pomodoro break` or `pomodoro finish --break`)
330+
* Displaying daily progress in status format (`%c/%g`)
331+
332+
The daily goal setting is used by the status format parts `%g` (goal) and `%c` (completed today) to show progress toward your daily target.

0 commit comments

Comments
 (0)