package owork
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=d35630a90700fcee9451709b1fc85ecc1381a67cd122fd7949b15e72c6c1143a
sha512=a86e40cf88ffccc0d41626f6d5c03eefbeee988f011052148f71406ed0d13f568b91e53e64b32e667f069bf831fca9846a88f838b73bd8ccbe9b873b6ddfa98e
Description
Owork is a productivity timer. It provides a server executable which uses a state machine to start different timers for sessions. There are four states: idle
, working
, short break
and long break
.
Published: 04 Nov 2019
README
owork
An OCaml implementation of a productivity timer. There is a server component at the moment which accepts connections over a Unix socket. The timer can then be started, paused/resumed, reset and sessions restarted.
Install
To install the program, first clone the repo and then run make install
(Note: opam
may be required to install necessary packages):
git clone https://github.com/jeffa5/owork.git
cd owork
make install
owork --help
Socket file
The default socket file is created at /tmp/owork.sock
. This can be overridden with a command-line option.
Protocol
The protocol is outlined in PROTOCOL.md
Examples
Some example client scripts to interact with the server can be found in the examples
directory.