00mjk / journeh

Journ'eh?

What is it

Do you wish you were better organized and you live in the terminal. Do you wish you could write a daily 'memoir' like all those pro out there just going full ham.

Look no more son! I got the tool for you, journeh: A french canadian tool, like it's author. This is the outcome of smashing the french word "Journee" with the canadianism "Eh?"

Journ'eh?, a tool to organize your daily shenanigans, even by quarters for you BA afficionados.

Usage

commands	effect
init <git url>	this will init the repo for remote backup.
day [date -d arguments]	create a daily journal entry.
week [date -d arguments]	create a weekly-end journal entry.
month [date -d arguments]	create a month-end journal entry.
quarter [date -d arguments]	create a quarter-end journal entry.
year [date -d arguments]	create a year-end journal entry.
[date -d arguments] to [date -d arguments]	create a ranged journal entry
[date -d arguments] from [date -d arguments]	create a relative from ranged journal entry
[date -d arguments]	create a daily journal entry for date
<blank>	create a daily journal entry for today
help	this.

For the date arguments, see the gnu core util date --date input format

Example

Some (but not limited) quick example of usage:

open yesterdays journal

journ day -1day
journ -1day
journ day yesterday
 # if today is the 23rd
journ day 2020-09-22

open todays journal

journ
journ day 

open ranged journal

journ 1day 8day
journ

open tomorow journal

journ day 1day
journ day tomorrow
journ +1day

open next mondays journal

journ day next monday

open a weekly summary

journ week next monday

open a ranged summary

journ -1day to + 1 day

open a relative ranged summary

journ 7days from 2020-09-17

---

New journal entry will be populated from the template.md located in $HOME/.journeh, then $PWD, then where the source for the tool is located.

The template.md is bash expanded upon usage for each new entry. The variable is used with $VAR or ${VAR}.

All the variables from journ.sh are currently exposed, here are some the ones available:

variable	value
ENTRY_NAME	the current entry display name
DATE	the target date in a single entry (is set to FROM in ranges)
FROM	the start date of the range (equals to DATE)
TO	the end date of the range

All the variable that can be adjusted from the configuration file are also available

configuration	value
THIS_DIR	the directory where this executable resides in
JOURNAL_DIR	the directory where the journal entries are kept
CONTEXT_BEFORE	the number of entries to print before the date in single entry mode
CONTEXT_AFTER	the number of entries to print after the date in single entry mode
AT_TOP	the new entry should be at the top for range
OLDEST_FIRST	swap the print order from newest to oldest to oldest to newest

Outro

Now go out there buddy, and show the world how neat and tidy your life is (just don't let them look at the pile of dishes).