Skip to content

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ptjournal

A simple shell script for arranging and accessing weekly notes in plaintext.

Installing

sudo make install

Will install the script into /usr/local/bin, and the template into /usr/share/notes.

Usage

Typing notes into your terminal will create a new file for the current week and open that file in vim.
Every file is named after the Monday which the week commences on, and is placed in the directory structure: ~/notes/$year/$month/$day. The result looks like this:

user@hostname:~/notes$ tree
.
└── 26
    ├── 04
    │   ├── 20
    │   └── 27
    └── 05
        ├── 04
        ├── 08
        └── 11

4 directories, 5 files
Options:

-p, --previous
    Open the previous week's entry

-d DATE, --date=DATE
    Use the format "DAY MONTH YEAR" for DATE.  Opens the entry for the specified date.  Currently if the specified date is not a Monday it will create a new file, so avoid doing this.

-s TERM, --search=TERM
    Search for TERM in all notes, displays occurences in chronological order, including which file they are in.

Customising

If you'd like to use an editor besides vim, just replace the final line in the script.

If you'd like to alter the template (to add weekends for example), do so before installing.
I may add a way to pick up user-defined templates from ~/.config/notes/template or something similar.

About

A simple shell script for arranging and accessing weekly notes in plaintext.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages