README
pjournal - Your Work Journal on the command line
PJournal is simple to use, but it is mostly an interface to edit a txt file. You can use it to write a new entry into your journal, or list past entries.
Setting it up
1- Clone this repository into your computer.
2- Copy the .pjournal.cfg file into your home directory (Windows not supported yet).
3- Just run the pjournal command and have fun.
Commands
Writing a new entry:
pjournal -w "Deployed the new layout to our production servers without telling anyone"
pjournal --write "My boss told me to refactor my code. I told him it would take 3 days and spent the first day on YouTube."
This appends a new line into your journal, adding date and time before the text. Also appends a blank line between entries.
Listing entries:
pjournal -l
pjournal --list
List your journal entries. If the list length is not defined (in your configs file), or defined as 0, it will list ALL entries.
Listing specific entries:
pjournal -l "pattern"
pjournal --list "pattern"
It is similar to the -l command, but will only list entries that match that specific regex pattern.
Limiting the number of entries returned:
pjournal -n 6 -l
pjournal --number 3 -l
If you pass the --number command, it will limit the -l command to that specific number of entries.
If you pass --number 0
, it disabled the length limit.
There are a few number shortcuts:
--one
--five
--ten