Repository files navigation

Welcome to clocked, a small, simple task-based time tracker. The motivationfor creating this was that I wanted to have something I could use to trackmy working time offline and at the end of the day easily sync up to JIRA.I've tried taskwarrior and OrgMode in the past but none of them offered me theUX and flexibility I wanted. So here we are ;-)

Getting started with clocked is quite simple. Just install it and start addingtasks to it. Every screen will show you a list of all the available keyboardcommands. If you don't want to sync your tasks with JIRA, then there is evennothing for you to configure :-)

If you do want to sync with JIRA, you will have to create a$HOME/.clocked/config.yml file and put your JIRA's URL and username into it:

jiraURL: https://jira.company.comjiraUsername: jdoe

When you start clocked for the next time then it will ask you for your JIRApassword and store it into a macOS keychain.

Once that is all done, make sure to create tasks that have the same code asthe tasks you have in JIRA. Then hit^s to enter the summary view to seeall the tasks you've worked on today. From there hit^j to enter thesync-view ands to actually start the synchronization.

This will delete all your worklogs of the selected date and create new onesfor your tasks as tracked by clocked.

If you don't want specific tasks not to be synchornized you can assign themthe tag "offline". These tasks will be shown on the sync-view as offlinetasks.

If you haverestic installed, clocked will create a snapshot after everychange to a task. If you create a new task, a snapshot will be made. If youclock in or out, a new snapshot will be made. By default the backup repositoryis stored in$HOME/.clocked_backups and its password is saved in$HOME/.clocked/backups.passwd

If you want to keep your backups somewhere else (e.g. inside a Dropbox folder)you have to do two things:

1. Move~/.clocked_backups to its target location.

2. Inside~/.clocked/config.yml add the following line:

   backups_path: /Users/yourname/Dropbox/clocked_backups

   Replace/Users/yourname/Dropbox/clocked_backups with whatever path youmoved the backups to in step 1 🙂

• --log-file <path/to/file> specifies a path to a logfile clocked shouldwrite to.
• --store <path/to/folder> specifies where clocked should store its files.Default:$HOME/.clocked