https://github.com/dirtyhenry/pomodoro-cli

🍅 A command-line Pomodoro Timer in Swift.
https://github.com/dirtyhenry/pomodoro-cli

pomodoro-cli pomodoro-technique pomodoro-timer swift swift-package-manager

Last synced: 6 days ago
JSON representation

🍅 A command-line Pomodoro Timer in Swift.

• Host: GitHub
• URL: https://github.com/dirtyhenry/pomodoro-cli
• Owner: dirtyhenry
• License: mit
• Created: 2017-11-04T21:37:00.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T13:34:00.000Z (25 days ago)
• Last Synced: 2024-10-21T21:53:55.554Z (25 days ago)
• Topics: pomodoro-cli, pomodoro-technique, pomodoro-timer, swift, swift-package-manager
• Language: Swift
• Homepage: https://dirtyhenry.github.io/pomodoro-cli/
• Size: 454 KB
• Stars: 26
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🍅 Pomodoro CLI

Pomodoro is a command-line interface to run timers from your terminal for people using the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique).

I started this project in 2017, as a pet project to learn how to write a CLI in [Swift](https://swift.org). I never stopped writing CLI tools from then.



  

  



## Usage

```

➜ Usage: pomodoro-cli [options]

CLI pomodoro

Options:

  -d, --duration     The duration of the pomodoro in seconds (100) or in minutes (10m) (default to 25m)

  -h, --help                Show help information

  -m, --message      The intent of the pomodoro (example: email zero)

```

## Hooks

Pomodoro can optionally run shell scripts when a pomodoro starts and/or finishes.

Sample scripts can be found in [the `SampleHooks` directory](https://github.com/dirtyhenry/pomodoro-cli/blob/main/Resources/SampleHooks).

## Journal

A journal of pomodoros is created in `~/.pomodoro-cli/journal.yml`.

## Installation

### From Source

To install from sources, [Swift](https://swift.org/getting-started/) is required.

Installing `swiftlint` and `swiftformat` via [Homebrew](https://brew.sh/), and having installed [Ruby](https://www.ruby-lang.org/fr/)/[Bundler](https://bundler.io) are recommended for an easy installation.

- `make install` will install development dependencies;

- `make deploy` will build a release binary, move it to `/usr/local/bin` by default, with default hooks installed;

Check out [`Makefile`](https://github.com/dirtyhenry/pomodoro-cli/blob/main/Makefile) for more development convenience commands.

### From Distribution Images

The `.dmg` files are created via:

```

make clean notarize

# and upon successful feedback from the Apple notary service:

make image

```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)

[blog-post]: https://bootstragram.com/blog/swift-command-line-pomodoro/

[bootstragram]: https://bootstragram.com