An open API service indexing awesome lists of open source software.

https://github.com/mlange-42/track

Track is a time tracking command line tool
https://github.com/mlange-42/track

cli-app time-tracking

Last synced: 7 months ago
JSON representation

Track is a time tracking command line tool

Awesome Lists containing this project

README

          

# Track

[![Test status](https://github.com/mlange-42/track/actions/workflows/tests.yml/badge.svg)](https://github.com/mlange-42/track/actions/workflows/tests.yml)
[![GitHub](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/mlange-42/track)
[![Docs](https://img.shields.io/static/v1?label=docs&message=mdBook&color=B7410E&logo=mdBook)](https://mlange-42.github.io/track/)
[![MIT license](https://img.shields.io/github/license/mlange-42/track)](https://github.com/mlange-42/track/blob/main/LICENSE)

Track is a time tracking command line tool.

*Track* is designed to be easy to use, and stores tracking entries in a human-readable plain-text format.

## Features

* Track your working time from the command line
* Natural language-like syntax
* Supports hierarchical project structure
* Records stored as plain-text files for human readability and editing
* Different types of text-based and graphical reports

## Getting started

See the **[:blue_book: Track Documentation](https://mlange-42.github.io/track/)** for a comprehensive user guide!

### Installation

**Using Go:**

```shell
go install github.com/mlange-42/track@latest
```

**Without Go:**

Download binaries for your OS from the [Releases](https://github.com/mlange-42/track/releases/).

### Usage

Any time tracking `track` is associated to a *Project*.
Before you can start tracking, create a project:

```shell
track create project MyProject
```

Now, start tracking time on the project:

```shell
track start MyProject
```

To stop tracking, use:

```shell
track stop
```

Get information about the current tracking status:

```shell
track status
```

See the [:blue_book: Track Documentation](https://mlange-42.github.io/track/) for details and more commands.

## References

* Heavily inspired by [`timetrace`](https://github.com/dominikbraun/timetrace) and [`klog`](https://github.com/jotaen/klog)