Skip to content

Latest commit

 

History

History
119 lines (88 loc) · 3.51 KB

README.md

File metadata and controls

119 lines (88 loc) · 3.51 KB
Raw

GoDoc Linux and macOS Build Status Go Report Card

This project is still in an early phase. It's usable and working but not yet recommended for production.

A simple UI is developed at https://github.com/jansorg/tom-ui (Qt5 tested on Linux and macOS). A preview for mac is available there.

tom

tom is a command line application to track time and to simplify office work. It's able to track time and to create HTML and PDF reports.

tom tracks time locally. Instead of implementing billing, etc. it will rely on 3rd-party tools, i.e. mostly cloud-based services.

Get tom

Instructions to get started until better documentation is available:

go install github.com/jansorg/tom@latest

After that tom will be available, assuming that your $GODIR/bin is in the $PATH.

If you want to build in place, then run this:

git clone https://github.com/jansorg/tom.git
cd tom
go build .

The binary tom will be in the current directory.

Basic usage

A typical session looks like this:

tom create project acme
tom start acme
sleep 10
tom stop
tom report --month 0

Documentation

Documentation about the command line is available at docs/markdown

Data model

The data is stored in a few JSON files on disk. It's easy to backup and still fast. Right now it's on disk at $HOME/.tom/. The available commands make it easy to export it into different target formats. Most commands are supporting plain text and JSON at this time. Other formats may be added in the future.

Projects

tom supports nested projects. The separator character is the slash '/'. The simplest form is a project without any subprojects.

If you need to bill a single client for several distinct project then it's better to use subprojects. For example:

tom create project client1 client1/web client1/backend
tom start client1/web
tom stop
tom report --split project -p client1

This will create a report on all projects which belong to client1 with the tracked time per project.

Tracking time

Start

Stop

Cancel

View

Reporting

Date and time filters

Splitting options

The reporting allows to split the tracked time into multiple pieces. Multiple levels of splitting is possible. Possible values:

  • year
  • month
  • project

For example, -split year creates a report where the tracked time is grouped into the years which are covered by tracked time. -split year,project will renders groups of years which are further grouped by the projects which were tracked in this particular year. -split project,month groups the tracked time by project first and then lists the summaries grouped by month for each project.

Plain Text Reports

HTML Reports

PDF Reports

api2pdf service integration

Import from other tools

Import data from Watson

tom import watson

Import data from Fanurio

This needs a custom CSV export (to be documented).

tom import fanurio complete-export.csv

Import data from Mac Time Tracker

This imports the CSV format exported by Mac Time Tracker.

tom import macTimeTracker export.csv

License

To be decided