⏱️⌛ rust-cli-pomodoro

Table of Contents

• Demo
• 💡 Motivation
• 📜 Features
• ⌛ Installation & How to use
• 🚧 RoadMap
• 🖥️ Compatibility

Demo

Motivation

Pomodoro technique is a time management method (Refer the link for more information). Typically 25 minutes works and 5 minutes break is one set. For me, while I'm working I found intentional break time is needed for the better performance and health (do some stretching 5 minutes). So I made it.

Features

A notification is consisted of work time and break time. Pomodoro manages timer using notification.

• Create notification with customized work and break time
• Queue the notification. Queued notification will start to run after previously registered notifications are finished
• Customize notification. Refer Using credential.json section
• Pretty print created notifications using list command
• Delete registered notification(s)
• Track delete notification(s) using history command
• Clear terminal

for more features, run pomodoro and type help!

```md pomodoro 1.0.0 Young manage your time!

USAGE: pomodoro [SUBCOMMAND]

FLAGS: -h, --help Prints help information -v, --version Prints version information

SUBCOMMANDS: clear clear terminal create create the notification delete delete a notification exit exit pomodoro app help Prints this message or the help of the given subcommand(s) history show archived notifications list list notifications long command ls list notifications short command q queue the notification queue queue the notification test test notification ```

Installation and How to use

Installation

1. Currently just clone this repo and run cargo run --release or build your self and use binary as you wish.

sh git clone git@github.com:24seconds/rust-cli-pomodoro.git cd rust-cli-pomodoro cargo run --release

1. Use cargo install rust-cli-pomodoro sh cargo install rust-cli-pomodoro

Using credential.json

pomodoro support slack notification. To use it, you need to create credential.json file in somewhere in your local machine. credential.json supports two keys, slack and discrod. The slack and discord value is json. It looks like this

json { "slack": { "token": "your-bot-token-string", "channel": "your-slack-channel-id" }, "discord": { "webhook_url": "your-webhook-url" } }

For the slack notification, It uses chat.PostMessage API

To run pomodoro with credential.json, run the app like this. ```sh

If the credential.json file exists in the current path

pomodoro --config ./credential.json ```

RoadMap

• [ ] Support mac os (>= 11.0.0) notification: Currently notify-rust uses mac-notification-sys but mac-notification_sys doesn't support recent mac version (as of 17:10 Sun 17 Oct 2021)
• [o] Provide more notification delivery option: Currently pomodoro uses desktop notification. But notification could be delivered through slack, email or any kind of method.
  • [v] slack integration
  • [v] discord integration
  • what else?
• [ ] Provide an easy way to use this app (brew, snap, cargo install, etc..)
  • [v] cargo install
• [ ] More rich notification: sound, app icon, hint, action etc
• [o] Write test cases
• [ ] Support executing pomodoro commands in any terminal tabs #27

Compatibility

It depends on notify-rust support, so Linux, Mac (<= 11.0.0) and Windows (10, 8.1). - note: If you use this app by installing cargo install command, then macOs desktop notification seems to work well (Sun 03 Apr 2022)