Giter Club home page Giter Club logo

pomodoro's Introduction

pomodoro

A simple terminal-based pomodoro timer

The point of pomodoro timers is to help you focus and save time. Unfortunately, I found myself wasting time with other tools. To fix that, I spent a few minutes making a simple timer for use in the terminal.

Usage

Here are some common ways to use the timer:

Start a 25 minute timer:

pomodoro

Start a short (5 minute) break:

pomodoro -s

Start a short (20 minute) break:

pomodoro -l

Start a 3 minute timer for tea:

pomodoro -c 3m

Start a 1 hour, 2 minute, 3 second timer:

pomodoro -c 1h2m3s

If you want to see more details, here's all options at the time of writing:

  • -c time, --custom time: start a custom timer (time in minutes)
  • -h, --help: show the help text
  • -l, --long: starts the timer for 20 minutes
  • -s, --short: starts the timer for 5 minutes

Remember: you can always run pomodoro --help to get the latest list of options available.

Install

You can install using Homebrew or manually build from source:

Install with Homebrew

Running this in your terminal adds my tap and installs the package:

brew tap blakek/blakek && brew install blakek/blakek/pomodoro

Build from Source

First, either clone this repo or download a zip file.

Then, in a terminal open to this project's directory, build with Go:

$ go build

Updating

If you installed using Homebrew, you can use the normal brew upgrade process.

The easiest way to update from a source build is to pull the latest changes (e.g. git pull) and re-run the install directions. If you keep the repository, you can occasionally run git pull && go build to build using the latest changes.

License

MIT

pomodoro's People

Contributors

blakek avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

schnphil

pomodoro's Issues

Feature to run a script on start

Can you add functionality to run a script from .config folder everytime a pomodoro starts ? . I want to be able to run a script that blocks website using https://github.com/SelfControlApp/selfcontrol/ . Which can be turned on by a shell script, and hopefully we can pass it the time parameter.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.