+
+
+
+ 404
+ +Page not found
+ + +Page not found
+ + +You can configure the way jrnl behaves in a configuration file. By
+default, this is ~/.jrnl_config. If you have the XDG_CONFIG_HOME
+variable set, the configuration file will be saved as
+$XDG_CONFIG_HOME/jrnl/.jrnl_config.
Note
+On Windows, The configuration file is typically found at C:\Users\[Your Username]\.jrnl_config.
The configuration file is a simple JSON file with the following options +and can be edited with any plain text editor.
+journals
+ paths to your journal fileseditor
+ if set, executes this command to launch an external editor for
+ writing your entries, e.g. vim. Some editors require special
+ options to work properly, see FAQ <recipes> for details.encrypt
+ if true, encrypts your journal using AES.tagsymbols
+ Symbols to be interpreted as tags. (See note below)default_hour and default_minute
+ if you supply a date, such as last thursday, but no specific
+ time, the entry will be created at this timetimeformat
+ how to format the timestamps in your journal, see the python docs for referencehighlight
+ if true, tags will be highlighted in cyan.linewrap
+ controls the width of the output. Set to false if you don't
+ want to wrap long lines.Note
+Although it seems intuitive to use the #
+character for tags, there's a drawback: on most shells, this is
+interpreted as a meta-character starting a comment. This means that if
+you type
+++
jrnl Implemented endless scrolling on the #frontend of our website.
your bash will chop off everything after the # before passing it to
+ jrnl. To avoid this, wrap your input into quotation marks like
+ this:
+++
jrnl "Implemented endless scrolling on the #frontend of our website."
Or use the built-in prompt or an external editor to compose your + entries.
+Using your DayOne journal instead of a flat text file is dead simple --
+instead of pointing to a text file, change your .jrnl_config to point
+to your DayOne journal. This is a folder named something like
+Journal_dayone or Journal.dayone, and it's located at
~/Library/Application Support/Day One/ by default~/Dropbox/Apps/Day One/ if you're syncing with Dropbox and~/Library/Mobile
+ Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/ if you're
+ syncing with iCloud.Instead of all entries being in a single file, each entry will live in a
+separate plist file. So your .jrnl_config should look like this:
{
+ ...
+ "journals": {
+ "default": "~/journal.txt",
+ "dayone": "~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/Journal_dayone"
+ }
+}
+You can configure jrnlto use with multiple journals (eg.
+private and work) by defining more journals in your .jrnl_config,
+for example:
{
+...
+ "journals": {
+ "default": "~/journal.txt",
+ "work": "~/work.txt"
+ }
+}
+The default journal gets created the first time you start jrnl
+Now you can access the work journal by using jrnl work instead of
+jrnl, eg.
jrnl work at 10am: Meeting with @Steve
+jrnl work -n 3
+will both use ~/work.txt, while jrnl -n 3 will display the last
+three entries from ~/journal.txt (and so does jrnl default -n 3).
You can also override the default options for each individual journal.
+If you .jrnl_config looks like this:
{
+ ...
+ "encrypt": false
+ "journals": {
+ "default": "~/journal.txt",
+ "work": {
+ "journal": "~/work.txt",
+ "encrypt": true
+ },
+ "food": "~/my_recipes.txt",
+}
+Your default and your food journals won't be encrypted, however your
+work journal will! You can override all options that are present at
+the top level of .jrnl_config, just make sure that at the very least
+you specify a "journal": ... key that points to the journal file of
+that journal.
Note
+Changing encrypt to a different value will not encrypt or decrypt your
+journal file, it merely says whether or not your journal
+is encrypted. Hence manually changing
+this option will most likely result in your journal file being
+impossible to load.
The Windows shell prior to Windows 7 has issues with unicode encoding.
+To use non-ascii characters, first tweak Python to recognize the encoding by adding 'cp65001': 'utf_8', to Lib/encoding/aliases.py. Then, change the codepage with chcp 1252 before using jrnl.
(Related issue: #486)
+ +If you don't choose to encrypt your file when you run
+jrnl for the first time, you can encrypt
+your existing journal file or change its password using
jrnl --encrypt
+If it is already encrypted, you will first be asked for the current +password. You can then enter a new password and your plain journal will +replaced by the encrypted file. Conversely,
+jrnl --decrypt
+will replace your encrypted journal file by a Journal in plain text. You
+can also specify a filename, ie. jrnl --decrypt plain_text_copy.txt,
+to leave your original file untouched.
Whenever you encrypt your journal, you are asked whether you want to +store the encryption password in your keychain. If you do this, you +won't have to enter your password every time you want to write or read +your journal.
+If you don't initially store the password in the keychain but decide to
+do so at a later point -- or maybe want to store it on one computer but
+not on another -- you can simply run jrnl --encrypt on an encrypted
+journal and use the same password again.
While jrnl follows best practises, true security is an illusion.
+Specifically, jrnl will leave traces in your memory and your shell
+history -- it's meant to keep journals secure in transit, for example
+when storing it on an
+untrusted
+services such as Dropbox. If you're concerned about security, disable
+history logging for journal in your .bashrc
HISTIGNORE="$HISTIGNORE:jrnl *"
+If you are using zsh instead of bash, you can get the same behaviour
+adding this to your zshrc
setopt HIST_IGNORE_SPACE
+alias jrnl=" jrnl"
+Should you ever want to decrypt your journal manually, you can do so +with any program that supports the AES algorithm in CBC. The key used +for encryption is the SHA-256-hash of your password, the IV +(initialisation vector) is stored in the first 16 bytes of the encrypted +file. The plain text is encoded in UTF-8 and padded according to PKCS#7 +before being encrypted. Here's a Python script that you can use to +decrypt your journal
+#!/usr/bin/env python3
+
+import argparse
+from Crypto.Cipher import AES
+import getpass
+import hashlib
+import sys
+
+parser = argparse.ArgumentParser()
+parser.add_argument("filepath", help="journal file to decrypt")
+args = parser.parse_args()
+
+pwd = getpass.getpass()
+key = hashlib.sha256(pwd.encode('utf-8')).digest()
+
+with open(args.filepath, 'rb') as f:
+ ciphertext = f.read()
+
+crypto = AES.new(key, AES.MODE_CBC, ciphertext[:16])
+plain = crypto.decrypt(ciphertext[16:])
+plain = plain.strip(plain[-1:])
+plain = plain.decode("utf-8")
+print(plain)
+With
+jrnl --tags
+you'll get a list of all tags you used in your journal, sorted by most +frequent. Tags occurring several times in the same entry are only +counted as one.
+jrnl --short
+Will only display the date and title of each entry.
+Can do
+jrnl --export json
+Why not create a beautiful timeline of +your journal?
+Use
+jrnl --export markdown
+Markdown is a simple markup language that is human readable and can be +used to be rendered to other formats (html, pdf). This README for +example is formatted in markdown and github makes it look nice.
+jrnl --export text
+Pretty-prints your entire journal.
+You can specify the output file of your exported journal using the
+-o argument
jrnl --export md -o journal.md
+The above command will generate a file named journal.md. If the-o argument is a directory, jrnl will export each entry into an individual file
jrnl --export json -o my_entries/
+The contents of my\_entries/ will then look like this:
my_entries/
+|- 2013_06_03_a-beautiful-day.json
+|- 2013_06_07_dinner-with-gabriel.json
+|- ...
+h!Ew-CkL#7+!+)@&03H!1k|bv@FI~pm8x%T+51^g^b@%x?Pg+
zraVHfqGq4W*Fb`gn#E4Il|x{YSp!T{~DyE1zP9t{i+&~$qH4Z
zQL?lP>B9+Npi9(+a61HvNmMP@^l*Sz3hoGjG&R!{xyNym2;>ujoCtzAS{BP