1.0.5 • Public • Published

    Journ, a command line journaling tool based on a weekly calendar

    Years ago, I started logging my daily journal in markdown format. I also started organizing my schedule by weeks. Counting Week 1 as Monday, Jan 2nd til Sunday, Jan 8th. Each day was recorded as markdown file with YEAR-WEEK-DAY format. ie. 2017-02-1 for 2nd week, Monday.

    This method kept all my days into single flat files which I could edit with VIM or any text editor and allowed easy manipulation to collate reports and storage in GitHub. I then wrote bash scripts that would concat the files and manage the files. This project takes those methods and creates a Node tool.


    npm install -g journ

    In your home or project directory, you can create a configuration file Change the journ.cfg.json if you like to journ directory to not be your home directory. The setup process will create the initial working directory and files.

    journ config
    journ setup


    journ new

    Takes the file and renames at a dated file for yesterday. Then creates a new file.

    journ . <a new journ entry>

    Will write the new line of text to the end of

    journ + <a new task>

    Will write a new task of text to the end of

    # Other commands
    journ help
    journ status
    journ week
    journ           // display status

    File system

    kyle@KMBP:~/journ$ pwd
    kyle@KMBP:~/journ$ ls -l
    total 57
    drwxr--r--   9    306B Jul  5 07:10 .
    drwxr-xr-x+ 50    1.7K Jul  5 07:09 ..
    drwxr-xr-x   6    204B Jul  4 09:43 2017
    -rw-r--r--   1     95B Jul  4 07:56
    -rw-r--r--   1     29B Jul  4 07:57
    -rw-r--r--   1    747B Jul  3 10:08 pdf.css
    -rw-r--r--   1     46B Jul  3 10:08
    -rw-r--r--   1     29B Jul  5 07:10
    -rw-r--r--   1    199B Jul  5 07:10



    I've references these other repos for this project. You may want to check them out, they have different approaches for journaling.


    This software is licensed under the MIT Licence. See


    npm i journ

    DownloadsWeekly Downloads






    Unpacked Size

    775 kB

    Total Files


    Last publish


    • avatar