Skip to content

README.md

Latest commit

 

History

History
108 lines (70 loc) · 2.21 KB

README.md

File metadata and controls

108 lines (70 loc) · 2.21 KB

🍅 Pomo CLI

A simple command-line Pomodoro timer.

Description

This is a CLI tool to help you manage your time using the Pomodoro Technique. You can start timers for specific tasks, view your task history, and stop running timers.

Installation

To use this tool, you need to have Go installed on your system.

  1. Clone or download the repository:

    git clone https://github.com/hmitsis-dev/pomo-cli
cd pomo-cli

  2. Build the executable:

    go build -o pom pom.go

    This will create an executable file named pom for your current OS.

    To specifically create a Windows executable (.exe) from a non-Windows OS, use the following command:

    GOOS=windows GOARCH=amd64 go build -o pom.exe

Adding to PATH for Easy Usage

To use pom from any directory, you should move the executable to a directory that is in your system's PATH.

macOS and Linux

  1. Move the executable:

    sudo mv pom /usr/local/bin/

    This moves the executable to a common directory for user-installed executables.

  2. Make it executable:

    sudo chmod +x /usr/local/bin/pom

Now you can run the tool by simply typing pom in your terminal.

Windows TO CHECK after making the .exe ( TO-DO )

Usage

The following commands are available:

start

Starts a new Pomodoro timer.

Flags:

  • --task: (Required) The name of the task you are working on.
  • --time: The duration of the Pomodoro session in minutes. Defaults to 25.
  • --background: Run the timer silently in the background.

Example:

pom start --task "Write documentation" --time 30

To run in the background:

pom start --task "Code review" --background

view

Displays the history of completed Pomodoro sessions.

Example:

pom view

stop

Stops a Pomodoro timer that is running in the background.

Example:

pom stop

stats

pom stats

Have a suggestion, question, or found a bug?
👉 Open an Issue

License

This project is licensed under the terms of the LICENSE file.