https://github.com/hemmouda/Journal
A bash script for your simple journaling
https://github.com/hemmouda/Journal
bash diary encrypted journal lock locked notes script secure
Last synced: 4 months ago
JSON representation
A bash script for your simple journaling
- Host: GitHub
- URL: https://github.com/hemmouda/Journal
- Owner: telos-matter
- License: mit
- Created: 2024-08-14T21:37:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-21T11:25:43.000Z (over 1 year ago)
- Last Synced: 2024-12-05T07:12:49.188Z (about 1 year ago)
- Topics: bash, diary, encrypted, journal, lock, locked, notes, script, secure
- Language: Shell
- Homepage:
- Size: 1.24 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Journal 
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:
```console
$ journal 1970 01 01
```
For all the possibilities, run:
```console
$ journal --help
```
## UX snippet:
### As the user is writing a new entry:
### When the user wants to read a previous journal:
## How-to:
1. Put the [**journal**](journal) script with your other **bin**aries, 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.