Giter Club home page Giter Club logo

tmt's Introduction

๐Ÿ… tmt

Command-line application for Pomodoro technique time tracking.

tmt demo

Overview

tmt is a Pomodoro timer command-line application written in Go. It's simple to use, configure, and integrate with your everyday command line flow.

By default, tmt is set for 25 minutes of work followed by a short 5-minute break. Every four completed work sessions are followed by, a long, 15 minutes break.

A work session is indivisible so there is no option to pause the timer. If you are interrupted you need to stop the application and abandon the incompleted work session.

There is an option to set up notifications for work or pause sessions. See configuration for more details.

Build and Run

$ make build
$ bin/tmt

Use Ctrl+C to stop timer.

Custom Configuration

tmt custom options are configurable and can be defined in $HOME/.tmt/config.json. Use Example config as a reference. This example is using macOS say command for work and pause notifications.

config.json

{
    "pomodoroLength":   25,
    "shortBreakLength":  5,
    "longBreakLength":  15,
    "pomodoroCmd": {
        "cmd": "say",
        "args": ["Start working"]
    },
    "shortBreakCmd": {
        "cmd": "say",
        "args": ["Take a 5 minute break"]
    },
    "longBreakCmd": {
        "cmd": "say",
        "args": ["Take a 15 minutes break"]
    }
}

Duration Configuration

  • pomodoroLength duration of the work item in minutes (default 25)
  • shortBreakLength duration of a short break in minutes (default 5)
  • longBreakLength duration of a long break after each four work items are completed (default 15)

Commands Configuration

  • pomodoroCmd command is executed before each work item
  • shortBreakCmdcommand is executed before a short break
  • longBreakCmd command is executed before a long break
    • cmd is the name of the command you want to execute
    • args is a list of arguments passed to the command

You can use https://github.com/julienXX/terminal-notifier to show macOS notifications.

"pomodoroCmd": {
    "cmd": "terminal-notifier",
    "args": ["-title", "๐Ÿ… TMT", "-message", "Start working for 25 minutes.", "-group", "tmt"]
},

tmt's People

Contributors

mribica avatar

Stargazers

 avatar

Watchers

 avatar

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.