Cli
clocking has a CLI to work in a standard way; track the time.
Common options
clocking has a common options to change environments.
| short | long | description | args |
|---|---|---|---|
| -v | --verbose | Enable verbosity | |
| -V | --version | Print version | |
| -B | --database | Select database file | Path of database file |
| -u | --user | Change user | Username |
Config subparser
clocking has config subparser to configure your personal settings.
clocking config --help
clocking cfg -h
clocking c -h
All options are intended to default of empty values of set subparser. It is possible configure more than one configuration per user.
Print group
Print options used to print the saved configurations.
| short | long | description | args |
|---|---|---|---|
| -p | Print current configuration | ||
| -t | --print-user | Print all user configurations | |
| -a | --print-all | Print all configurations |
clocking config --print
clocking config --print-user
clocking config --print-all
Set group
Set options used to add default configurations for the user.
| short | long | description | args |
|---|---|---|---|
| -D | --daily-hours | Daily work hours | hours |
| -N | --working-days | Working day's name | Mon,Tue,Wed,Thu,Fri,Sat,Sun |
| -E | --extraordinary | Extraordinary hour value | hours |
| -P | --permit-hours | Permit work hour value | hours |
| -U | --other-hours | Other hour | hours |
| -S | --disease | Disease value | text |
| -H | --holiday | Holiday value | text |
| -C | --currency | Currency value | text/symbol |
| -R | --hour-reward | Hour reward | float |
| -W | --extraordinary-reward | Extraordinary hour reward | float |
| -F | --food-ticket | Food ticket reward | float |
| -O | --other-reward | Other reward | float |
| -L | --location | Current location | location |
| -e | --empty-value | Fill empty date with value | text |
clocking config --daily-hours 8 --other-hours 1 --working-days Mon Tue Wed --hour-reward 8 --extraordinary-reward 10 --food-ticket 7 --location "Milan Office" --currency "€"
clocking config --daily-hours 8 --other-hours 1 --hour-reward 10 --extraordinary-reward 15 --location "Pasadina Office" --currency "$"
Selection group
Selection options used to load a configurations for the user.
| short | long | description | args |
|---|---|---|---|
| -i | --select-id | Load configuration selecting id | id |
clocking config --select-id 1
Reset group
Reset options used to reset all configurations for the user.
| short | long | description | args |
|---|---|---|---|
| -r | --reset | Reset all configurations |
clocking config --reset
Delete group
Delete options used to permanently delete the configurations for the user.
| short | long | description | args |
|---|---|---|---|
| -d | --delete-id | Delete configuration selecting id | id |
| -z | --delete-db | Delete whole database | |
| -f | --force | Force delete action without prompt confirmation |
clocking config --delete-id 1
clocking config --delete-db
clocking config --delete-id 1 --force
clocking config --delete-db --force
Set subparser
clocking has set subparser to insert/modify/reset data.
clocking set --help
clocking st -h
clocking s -h
Daily group
Daily group is exclusive. Choose one flag mode to set values.
| short | long | description | args |
|---|---|---|---|
| -w | --hours | Set worked hours | hours |
| -s | --disease | Set disease day | |
| -H | --holiday | Set holiday day | |
| -G | --holidays-range | Set holiday days | days |
| -c | --custom | Set fill selected date with custom value | value |
| -r | --reset | Reset selected date with default fill empty value | |
| -R | --remove | Remove date value |
clocking set --hours 8
clocking set --disease
clocking set --holiday
clocking set --holidays-range 7 8 9 11 12 23
clocking set --custom "Today I am boring!"
clocking set --reset
clocking set --remove
Other options
set subparser supports other options.
| short | long | description | args |
|---|---|---|---|
| -f | --force | force delete action without prompt confirmation | |
| -e | --extraordinary | Set extraordinary hours | hours |
| -o | --other | Set other hours | hours |
| -l | --location | Set current location | text |
| -p | --permit | Set permit hours | hours |
| -t | --description | Set description | text |
clocking set --reset --force
clocking set --remove --force
clocking set --hours 8 --extraordinary 1
clocking set --hours 8 --other 1
clocking set --hours 8 --location "New York Office"
clocking set --hours 7 --permit 1
clocking set --hours 8 --description "New project"
Date options
set subparser inheritance date options.
| short | long | description | args |
|---|---|---|---|
| -D | --date | Set literally date | date |
| -d | --day | Set day | day |
| -m | --month | Set month | month |
| -y | --year | Set year | year |
clocking set --hours 8 --date "15/7/2023"
clocking set --hours 8 --date "7.15.2023"
clocking set --hours 8 --date "2023-7-15"
clocking set --hours 8 --day 31
clocking set --hours 8 --month 2
clocking set --hours 8 --year 2022
clocking set --hours 8 --day 31 --month 2 --year 2022
Delete subparser
clocking has delete subparser to delete data.
clocking delete --help
clocking del -h
clocking d -h
| short | long | description | args |
|---|---|---|---|
| -C | --clear | Clear all data for user | |
| -f | --force | Force delete action without prompt confirmation |
clocking delete -C
clocking delete -C -f
Date options
delete subparser inheritance date options.
| short | long | description | args |
|---|---|---|---|
| -D | --date | Set literally date | date |
| -d | --day | Set day | day |
| -m | --month | Set month | month |
| -y | --year | Set year | year |
clocking delete -C --date "15/7/2023"
clocking delete -C --day 31
clocking delete -C --month 2
clocking delete -C --year 2022
clocking delete -C --day 31 --month 2 --year 2022
clocking delete -C --day 31 --month 2 --year 2022 -f
Print subparser
clocking has print subparser to print selected data.
clocking print --help
clocking prt -h
clocking p -h
| short | long | description | args |
|---|---|---|---|
| -U | --all | Print whole user data | |
| -c | --csv | Print in csv format | |
| -j | --json | Print in json format | |
| -l | --html | Print in html format | |
| -H | --holiday | Print only holidays | |
| -s | --disease | Print only diseases | |
| -e | --extraordinary | Print only extraordinaries hours | |
| -o | --other-hours | Print only other hours | |
| -p | --permit-hours | Print only permit hours | |
| -E | --export | Suppress output and export values into file | |
| -r | --rewards | Print rewards |
Date options
print subparser inheritance date options.
| short | long | description | args |
|---|---|---|---|
| -D | --date | Set literally date | date |
| -d | --day | Set day | day |
| -m | --month | Set month | month |
| -y | --year | Set year | year |
clocking print --date '01/25/2022'
clocking print --day 25 --month 1 --year 2022
clocking print --year 2022 --month 1
clocking print --year 2022
clocking print --holiday --year 2022
clocking print --disease --month 1
clocking print --disease --year 2022
clocking print --date '01/25/2022' --csv
clocking print --day 25 --month 1 --year 2022 --html
clocking print --year 2022 --json
clocking print --date '01/25/2022' --rewards
clocking print --month 1 --export /tmp/my_hours.txt