JRNLC(1)

NAME
jrnlc - Command line journaling tool

SYNOPSIS
jrnlc [-adeV] [-B file] [-D number] [-I number] [-I number]

DESCRIPTION
jrnlc is an opinionated command line journaling tool. You can take notes by entering them directly on the command line or by feeding a text file via standard input to jrnlc. If wanted, you can encrypt your journal so that your notes remain secret.

The options are as follows:

-a  Show all journal entries.

-B  Print an unecrypted backup of the journal to stderr. You can combine this option with other ones.

-d  Decrypt an encrypted journal.

-D number
    Delete the journal entry with the given number.

-e  Encrypt an unecrypted journal.

-I number
    Show only the entry with the given number.

-n n
    Show only the last n entries.

-V  Show the version number.

If not arguments are provided jrnlc provides the user with an input prompt to enter a journal entry. See the examples section below on how to use jrnlc.

ENVIRONMENT
jrnlc makes use of the following environment variables.

HOME
    If the XDG_CONFIG_HOME variable is not set, jrnlc stores the journal and other data in the .config/jrnlc subdirectory in the user's home directory.

XDG_CONFIG_HOME
    In case this variable is set, jrnlc stores the journal and other data in the jrnlc subdirectory under the path set by this environment variable.

EXIT STATUS
jrnlc normally exists with 0 or with 1 if an error occurred.

EXAMPLES
The following examples show how to use jrnlc.

Create a new journal entry on the command line. Provide one title line, followed by a blank line and end with Ctrl+d on a blank line.

    $ jrnlc
    [One title line, one blank line, then the body. End with ^D on a blank line]
    Test title line
    And here's the content

The next command shows the last two journal entries:

    $ jrnlc -n 2
    [2021-12-11 15:09] Vel ut dolorem earum ratione.
    Id dolorem ducimus quis consectetur corrupti vitae.
    Modi corrupti incidunt repellat magni et nihil.
    Ea similique qui commodi possimus est.
    [2021-12-11 15:32] test  title line
    and here's the content

Create a new journal entry from a file. This way you can create your entry in your text editor of choice and simply import it into jrnlc.

    $ cat sample_entry.txt
    Vel ut dolorem earum ratione.
    Id dolorem ducimus quis consectetur corrupti vitae.
    Modi corrupti incidunt repellat magni et nihil.
    Ea similique qui commodi possimus est.
    $ jrnlc < sample_entry.txt
    [One title line, one blank line, then the body. End with ^D on a blank line]
    $

Encrypt the journal using a password. Choose a good and strong password and remember it well (or use a password manager).

    $ jrnlc -e
    Encrypting journal...
    Enter Password:
    Enter Password again:

AUTHORS
jrnlc was written by Matthias Schmidt <xhr@giessen.ccc.de>.