artourter / diary

Script to create diary annotations and explore, visualize and mantain copies of it.

diary

Script to create diary annotations and explore, visualize and mantain copies of them. It is possible to create as many diaries as desired and every day is stored in an individual text-file.

(It has been tried in Ubuntu and Debian)

All the diaries are stored in "~/diary/" and separated folders per each diary name.

DIARY_PATH="${HOME}/diary"

By default the text editor is vim.

EDITOR="vim + "

For nice visualization of the diary in the web-browser it is recommended to use markdown syntax. The default web-browser is the default in Ubuntu.

EXPLORER="sensible-browser"

In other Operating Systems you could choose any other web-browser (e.g. firefox).

EXPLORER="firefox"

Show the help

$ diary --help
Usage: /home/maikel/bin/diary [OPTION]... [DIARY_NAME]
Opens todays page of the DIARY_NAME diary or performs any of the specified
options.

    OPTIONs

     -h, --help       Show the help
     -v, --version    Show the actual version information
     -ls              Show the name of all the diaries
     -lsl             List the name of all the diaries
     -lt              List available templates
     -e, --explore    Open a web-browser with the content of the specified diary
     -s, --search     Searches the following sentence in the specified diary
                      (or in all the diaries if the diary name is ommited)
     -y, --year       all or year (default current year)
     --last           Number of pages from the end
     -t, --todo       Show all the TODO tags
     -m, --template   Appends a template to the current day
     -push            Push all the changes to a repository
     -pull            Pull all the changes from a repository

Report bugs to <[email protected]>.

Create or open a diary

If is the first annotation of the day it creates a new page. If not, it opens the actual page (text-file).

diary name_of_the_diary

Show the name of your diaries

diary -ls

or in a list

diary -lsl

Search one sentence

If the name of the diary is not specified the sentence is searched in all the diaries

diary -s "sentence" name_of_the_diary

Explore one diary

Visualize all the pages of a diary in a web-browser

diary -e name_of_the_diary

Save your diaries

diary -push

Update your diaries

diary -pull