feierabend

README

FEIERABEND - A mite integration for software developers

88888888888          88                                      88                                             88
88                   ""                                      88                                             88
88                                                           88                                             88
88aaaaa   ,adPPYba,  88   ,adPPYba,  8b,dPPYba,  ,adPPYYba,  88,dPPYba,    ,adPPYba,  8b,dPPYba,    ,adPPYb,88
88"""""  a8P_____88  88  a8P_____88  88P'   "Y8  ""     `Y8  88P'    "8a  a8P_____88  88P'   `"8a  a8"    `Y88
88       8PP"""""""  88  8PP"""""""  88          ,adPPPPP88  88       d8  8PP"""""""  88       88  8b       88
88       "8b,   ,aa  88  "8b,   ,aa  88          88,    ,88  88b,   ,a8"  "8b,   ,aa  88       88  "8a,   ,d88
88        `"Ybbd8"'  88   `"Ybbd8"'  88          `"8bbdP"Y8  8Y"Ybbd8"'    `"Ybbd8"'  88       88   `"8bbdP"Y8

Feierabend is a simple command-line utility to push time entries to the mite time-tracking service, that contain a generated note with all commits from one or several git projects.

The whole process is interactive and asks the user how long he worked on each project prior to creating the time entries.

Creating time entries for days in the past is also possible.

The user config file .feierabend.yml is placed in the home directory and contains information required to authenticate to mite. Optionally, a list of projects can be supplied, that will be checked on every execution:

name: "Your Name"
apiKey: "<API-KEY>"
team: "Your Team"
userName: "you@company.com"
projects:
  - "/Users/you/Developer/awesome-project"
  - "/Users/you/Developer/project-xyz"

The project config file .feierabend.yml is placed in the root of the repository. It contains the mite project and customer of the repository:

customer: GoodCustomer
project: AwesomeProject

The idea here is, that at the end of a long working day, you are running the command

$ feierabend

in your terminal, it will prompt you for the total amount of time you worked on each project and you are free to go!

To assist with the project configuration, the commandline tool can list all users, projects and customers to the terminal.

Help

$ feierabend -h
Usage of feierabend:
-customers
        list all available mite customers
-date string
        set a date
-debug
        toggle debug mode
-dir string
        specify a project directory (default ".")
-projects
        list all available mite projects
-users
        list all available mite users
-yesterday
        show yesterday

How do I even pronounce this weird German word?

https://www.youtube.com/watch?v=WsZJNfqJDM4

It means end of the work day :)

License

GPLv3