Skip to content

A bash script for your simple journaling

License

Notifications You must be signed in to change notification settings

telos-matter/Journal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Journal   DEVELOPMENT STATUS: completed

A bash script for your simple journaling.

Write your daily journals and read them with ease, or keep them safe with a password.

Basic usage:

Simply run journal with no arguments to write a new journal for today, or add a new entry.

Some settings can be modified inside the script, like wether or not to lock the journals by default, what editor to use, and some other stuff.

To read a journal, simply specify the date it was written on. Like so for example:

$ journal 1970 01 01

For all the possibilities, run:

$ journal --help

UX snippet:

As the user is writing a new entry:

writing an entry


When the user wants to read a previous journal:

reading a previous journal

How-to:

  1. Put the journal script with your other binaries, or in a separate folder, but then don't forget to include that folder to your PATH variable (There are plenty of resources out there if you don't know how to do the latter)
  2. Add execution rights to it: $ chmod u+x journal
  3. Rehash to use instantly: $ rehash

Note:

Some date commands may not work with Linux distros. Only tested on MacOS.

⚠️   Important note:

Keep in mind that if you lose the password for a journal, that journal is locked forever and cannot be unlocked.