Skip to content

marcelovicentegc/kontrolio

Repository files navigation

Build and test

kontrolio logo

kontrolio-cli

Kontrolio's CLI time clock, clock card machine, punch clock, or time recorder.


kontrolio logs


Installation

See Troubleshooting if you have any issues on installation.

Usage

$ kontrolio
NAME:
   kontrolio - Your cli time clock, clock card machine, punch clock or time recorder

USAGE:
   kontrolio [global options] command [command options] [arguments...]

VERSION:
   0.x

COMMANDS:
   config, c              Configure Kontrolio
   logs, l                Navigate through all your records
   punch, p               Punch your clock
   push                   Push your records to Google Drive
   status, s              Check how many hours have you worked today
   help, h                Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help (default: false)
   --version, -v  print the version (default: false)

Troubleshooting

In case you receive an EACESS error while trying to execute kontrolio after installing it with npm or yarn, change the file permissions with chmod 755 <path_to_binaries>.

Development

Make sure you have a .kontrolio.yaml file under your home directory (/home/marcelo on Linux, /Users/Marcelo on macOs, C:\Users\Marcelo on Windows) with dev set to true, like this:

dev: true