Tomato Timer CLI

Table of Contents

• Tomato Timer CLI
  • Table of Contents
  • Introduction
  • Features
  • Perquisites
  • Installation
  • Usage
  • Change Log
  • Contributing
  • Code of Conduct
  • License

Introduction

The Tomato Timer CLI is a command-line tool designed to help you manage your time effectively using the Pomodoro Technique. With this tool, you can break your work into focused intervals called "pomodoros" and take short breaks in between. This technique helps improve productivity and maintain focus throughout your work sessions.

Features

• Start and stop pomodoro sessions
• Set custom durations for pomodoros and breaks
• Track your progress with a visual timer
• Receive notifications when a pomodoro or break ends unless no audio device found

Perquisites

• Cargo

Installation

Run the following command to install the Tomato Timer CLI. Cargo will download and compile the source code for you.

cargo install tomato-timer-cli

Usage

To run with default settings, follow the instructions below.

tomato-timer-cli

To get help information, follow the instructions below.

tomato-timer-cli --help

Change Log

Please refer to the CHANGELOG for more information.

Contributing

If you would like to contribute to this project, please read the CONTRIBUTING guidelines.

Code of Conduct

Please read the CODE_OF_CONDUCT before contributing.

License

This project is licensed under the MIT License - see the LICENSE file for details.