Getting Started

When you are getting started using rtimelog, there are a couple of steps that you will do once and then never again: installing the program and initializing it.

Installation

Since rtimelog is written in Rust, the easiest way to install it is from crates.io using the cargo application. If you have cargo installed, type the following on the command line.

  $ cargo install rtimelog

If you are interested in checking out the source of the tool, you can get the latest version from the gitlab repo. You will still need to build a Rust executable to make use of rtimelog.

Initialization

The rtimelog program requires a directory where it stores its log files. This directory may be specified in the .timelogrc configuration file in your home directory. If that file does not exist, the program defaults to the timelog directory in your home directory.

You can use the init command to set up the configuration file and directory for you. If the default configuration is satisfactory, just run the following command:

  $ rtimelog init

If you would like to change the directory where the logs are stored, supply that directory path as an argument to the init command.

  $ rtimelog init ~/my_timelog

Note

For more information about configuring the program, check out the configuration section of the Manual.