pomodoro-cli

command module
v0.0.0-...-2cd6567 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 22, 2021 License: MIT Imports: 1 Imported by: 0

README

Pomodoro-cli

Pomodoro command-line interface. It's very simple and you can only start and cancel a pomodoro. The job is running in the background, so you can just start it from a terminal and kill the terminal after if you want.

Examples

# Start pomodoro (Default timer is 25mins)
$ pomodoro-cli start
Started pomodoro 13 Jun 2021 23:12. The pomodoro will end 13 Jun 2021 23:13.

# Start pomodoro with duration 30 mins
$ pomodoro-cli start -d 30
Started pomodoro 13 Jun 2021 23:22. The pomodoro will end 13 Jun 2021 23:52.

# Cancel the current pomodoro
$ pomodoro-cli cancel

# Status of the current pomodoro
$ pomodoro-cli status
24:51

Config

The config path is ~/.config/pomodoro-cli. The folder contains

  • config.yaml the file to config pomodoro-cli.
  • pomodoros.json contains the current and all previous pomodoros.
Hooks

If you want to execute a command when the pomodoro finishes then place an executeable script named finished in the current path ~/.config/pomodoro-cli.

Here is an example where I play a sound when the pomodoro is over.

#!/bin/env bash

ffplay -nodisp -autoexit ~/.config/pomodoro-cli/break_sound.mp3

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL