Git Product home page Git Product logo

timetrack's Introduction

Timetrack

This project is a time tracking utility heavily inspired by timetrap, but written in Rust, to improve performance.

Timetrack does not aim to be a full timetrap clone, but includes the most used commands and both a user-friendly output and a JSON output that can be piped into other commands or applications.

Installation

Currently timetrack is only available through git, but it will soon be published to crates.io.

To install it, you can use the following command:

cargo install --git https://github.com/andreadev-it/timetrack

After installing, the t command will be available.

You can then run t help to check all the available commands. Then, for every comand, you can ask for more information like this: t display --help.

Usage

Timetrack is based on the idea of timesheets, which can be started and stopped, with additional notes that can be passed every time you start the timer. You can also think about it as lists of tasks.

You will start in the "default" sheet. To check into the sheet (start the timer) run this command:

t in first-task

The "first-task" note is optional, but it's very useful.

When you're done with your work, you can check out of the timesheet by running:

t out

Both the in and out command accept a --at parameter where you can specify when the task was started or has been finished. It accepts values like "5 minutes ago", "yesterday at 10:30" or "12pm".

When you've checked in and out, if you want to see the current situation, you can run the following command:

t display

To change the active timesheet you can run:

t sheet new-sheet

Then you can run the following command to list all available sheets:

t list

Remember also that every command can be shortened to its first non-ambiguous letter. For example, t sheet becomes t s, t out becomes t o, etc.

Next steps

  • Add the "month" command as an alias for display
  • Check for edge cases (e.g. all sheets removed)
  • Improve code quality
  • Add errors contexts
  • Add tests
  • Write docs
  • Publish on crates.io

timetrack's People

Contributors

andreadev-it 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.