Stupf - ReadMe

The stupf-tool is a CLI-tool with one major purpose: Log your working hours and calculate overtime.

At the same time, stupf aims to have minimal overhead to your daily working routine -- no more manual filling of Excel tables.

Introduction

Stupf assumes that every day which is not weekend, a holiday, or vacation adds a fix (adjustable) amount of due hours to the time account. Every logged session is then then added as fulfilled hours. The difference of both yields the overtime.

For correct calculation, you can set (and unset) days as holidays or vacation. To adjust stupf to your needs, you can set the daily due hours, the overtime that you carry over from last year, the new number of vacation days, and the vacation days that you carry over from last year.

Basic usage

You start your working session with the command

stupf ein

and stop the session with

stupf aus

With

stupf show

all sessions of the current day are displayed.

Adjustment for the overtime calculation can be done with the subcommand

stupf meta

Use

stupf help

for further documentation and read the User Stories, below for hands-on examples.

Installation and first start-up

coming soon...

User Stories

coming soon...