/diary

Simple CLI diary

Primary LanguageCMIT LicenseMIT

CLI Diary

This is a text based diary, inspired by khal. Diary entries are stored in raw text. You may say C & ncurses are old, I say paper is older..

Diary Demo

Usage

  1. Set the EDITOR environment variable to your favourite text editor:

    export EDITOR=vim
    
  2. Compile (requires ncurses):

    make
    

Note: for *BSD users run gmake.

  1. Install the binary (optional):

    sudo make install
    

    By default this will copy the binary to /usr/local/bin. To use a different path prefix, type sudo make --PREFIX=/usr install to use /usr/bin for example. You can uninstall diary with sudo make uninstall.

  2. Run the diary, with the folder for the text files as first argument:

    diary ~/.diary
    

    Instead of this, you can also set the environment variable DIARY_DIR to the desired directory. If both an argument and the environment variable are given, the argument takes precedence.

    The text files in this folder will be named 'yyyy-mm-dd'.

  3. Use the keypad or VIM-like shortcuts to move between dates:

    e, Enter  Edit the current entry
    d, x      Delete/remove current entry
    t         Jump to today
    s         Jump to specific day
    
    j, down   go forward by 1 week
    k, up     go backward by 1 week
    h, left   go left by 1 day
    l, right  go right by 1 day
    
    N         go to the previous diary entry
    n         go to the next diary entry
    
    g         go to the first date
    G         go to the last date
    
    J         Go forward by 1 month
    K         Go backward by 1 month
    
    q         quit the program
    

Build Status