package owork
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=034f5b9513ef2429a112f7ae1fcd7d64b2c276ac48f9d03ea054a10ac575d135
sha512=beeffd10930fa739b5b1c5d244c28e97003241095096cd44a5605ae135718d9695cd647c7cf43a4b84811f40c193c0e2a8c7242bde9d9addb4a6267e73a1dc24
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: 01 Jul 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.