Skip to content
A command-line journal with optional encryption
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
chronicle.sh

README.md

Chronicle

A command-line future-proof journal with optional encryption.

Installation

Put the Chronicle in your path:

$ sudo cp chronicle.sh /usr/bin/chronicle

or link to it:

$ sudo ln -s $PWD/chronicle.sh /usr/bin/chronicle

Configuration

First, have Chronicle generate the default config file:

$ chronicle default-config $HOME/.chronicle.cfg

Now you can modify the options as you wish:

Writing entries

Vim has been selected for you as the default editor. It starts you in insert mode at the end of the prepared file. You can customize which editor you would like to use with the EDITOR option:

... if you don't like to be in insert mode by default:

EDITOR="vim"

... if you're one the other side:

EDITOR="emacs"

... if you don't like using the terminal:

EDITOR="gedit"

... or anything else that takes a filename as a first argument.

Encryption

Encryption is disabled by default, you can enable it by setting the ENCRYPTION option to TRUE. You can change the ENCRYPTION_METHOD as well, as Chronicle uses openssl for encryption.

ENCRYPTION="TRUE"
ENCRYPTION_METHOD="aes-256-cbc"

Filename and path conventions

Journal entries are saved in the CHRONICLE_DIR directory in the subdirectory and file defined by the DATE_FORMAT option.

CHRONICLE_DIR=$HOME/.chronicle.cfg
DATE_FORMAT=%Y/%m/%d/%H:%M:%S

Synchronisation

Chronicle does not handle synchronisation, but you can put your CHRONICLE_DIR directory in your Dropbox or something of that sort.

Usage:

To write an entry:

$ chronicle enter
You can’t perform that action at this time.