Collect your thoughts and notes without leaving the command line.
Find a file
Craig MacEachern 037784f783 Update advanced.rst (#527)
Update to clarify that jrnl creates .jrnl_config file under $XDG_CONFIG/jrnl/ folder (I mistakenly interpreted the original to mean the config file should be called $XDG_CONFIG/jrnl, and was super confused that jrnl did not read it).
2018-02-19 14:49:01 -08:00
docs Update advanced.rst (#527) 2018-02-19 14:49:01 -08:00
features Fix failing behave tests (#447) 2017-01-04 10:24:03 -08:00
jrnl Do not crash if subdirs found inside Day One dir (#430) 2016-07-14 14:24:48 -07:00
.gitignore Added PyCharm project files to .gitignore 2014-07-03 09:11:29 +02:00
.travis.yml Add most recent Python versions in Travis CI (#474) 2017-03-09 12:47:52 -08:00
CHANGELOG.md Fixes #308 2014-11-17 15:36:43 +01:00
CONTRIBUTING.md Update CONTRIBUTING.md 2017-01-04 12:02:53 -08:00
LICENSE Mark jrnl as 3.4 compatible 2014-05-22 14:18:15 -07:00
Makefile Updated docs from master 2017-03-09 12:09:05 -08:00
MANIFEST.in Manifest update 2014-07-27 12:43:26 +09:00
README.md Copy update 2017-12-11 11:34:29 -08:00
setup.py Copy update 2017-12-11 11:34:29 -08:00

jrnl Build Status Downloads Version

For news on updates or to get help, read the docs, follow @maebert or submit an issue on Github.

jrnl is a simple journal application for your command line. Journals are stored as human readable plain text files - you can put them into a Dropbox folder for instant syncing and you can be assured that your journal will still be readable in 2050, when all your fancy iPad journal applications will long be forgotten.

jrnl also plays nice with the fabulous DayOne and can read and write directly from and to DayOne Journals.

Optionally, your journal can be encrypted using the 256-bit AES.

Why keep a journal?

Journals aren't just for angsty teenagers and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't. For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it. For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it.

In a Nutshell

to make a new entry, just type

jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book.

and hit return. yesterday: will be interpreted as a timestamp. Everything until the first sentence mark (.?!) will be interpreted as the title, the rest as the body. In your journal file, the result will look like this:

2012-03-29 09:00 Called in sick.
Used the time to clean the house and spent 4h on writing my book.

If you just call jrnl, you will be prompted to compose your entry - but you can also configure jrnl to use your external editor.

Installation

Install jrnl using pip:

pip install jrnl

Or, if you want the option to encrypt your journal,

pip install jrnl[encrypted]

Alternatively, on OS X with Homebrew installed:

brew install jrnl