Giter Site home page Giter Site logo

toki's Introduction

⏳ toki

License Latest release Coverage status

toki () is a Bash wrapper around timew, the Timewarrior CLI.

Features

  • Extra commands
  • Convenient aliases for built-in commands
  • Extended duration syntax (e.g. timew track tag for 1h35m20s)
  • Allows using m as suffix for minutes instead of months
  • Acts on the latest interval by default
  • Notifies of errors when running timew outside of a terminal
  • Thoroughly tested

Installation

Make sure you have installed Timewarrior first.

Note: toki is only compatible with the 1.4.x version of timew

Clone the repo or download the scripts from the latest release, and make sure they're executable (chmod +x <scripts>).

The toki script can be use in place of timew (one character less to type!). Or, if you don't want to retrain your fingers, you can alias timew to toki and get all of its benefits transparently.

External dependencies

The toki-restart commands uses jq to parse JSON, so you need to install jq if you want to use it.

Completion

Source _completion.bash in your bashrc to enable better completion.

Usage

toki is used exactly like timew, with a few additions and differences that are listed below.

Commands that expect an ID (delete, tag, lengthen, etc.) will default to @1 if none is provided.

Extra commands

  • toki-cut: stop tracking and truncate the stopped interval to the closest minute
  • toki-restart: cancel and restart an interval
  • toki-restore: resume tracking of the last interval and automatically fill the gap
  • toki-switch: cut the current interval and starts another

See toki help <command> for more info.

Aliases

  • lengthen: +, extend
  • shorten: -, reduce
  • join: merge
  • track: t, a, add, record
  • continue: restart
  • delete: d, remove

Extended duration syntax

toki adds support for the following duration syntaxes:

  • <minutes>m (the m suffix is treated as minutes instead of months)
  • <hours>h<minutes>
  • <hours>h<minutes>m
  • <hours>h<minutes>m<seconds>
  • <hours>h<minutes>m<seconds>s

Contributing

Contributions are welcomed! Please open an issue before submitting substantial changes.

Related

License

ISC

toki's People

Contributors

cheap-glitch avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

lykos153

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.