1JRNL(1) User Commands JRNL(1)
2
6 jrnl - manual page for jrnl version v2.8.4
7
9 usage: __main__.py [--debug] [--help] [--version] [--list] [--encrypt]
10 [--decrypt] [--import] [-on DATE] [-today-in-history] [-month
12 DATE] [-day DATE] [-year DATE] [-from DATE] [-to DATE] [-con‐
13 tains TEXT] [-and] [-starred] [-n [NUMBER]] [-not [TAG]]
14 [--edit] [--delete] [--format TYPE] [--tags] [--short] [--con‐
15 fig-override CONFIG_KV_PAIR CONFIG_KV_PAIR] [--config-file CON‐
16 FIG_FILE_PATH] [...]
17 Collect your thoughts and notes without leaving the command line
19 Optional Arguments:
21 --debug
22 Print information useful for troubleshooting
23 Standalone Commands:
25 These commands will exit after they complete. You may only run
26 one at a time.
27 --help Show this help message
29 --version
31 Print version information
32 --list List all configured journals
34 --encrypt
36 Encrypt selected journal with a password
37 --decrypt
39 Decrypt selected journal and store it in plain text
40 --import
42 Import entries from another journal. Optional parameters:
43 --file FILENAME (default: uses stdin) --format [jrnl] (default:
44 jrnl)
45 Writing:
47 To add a new entry into your journal, simply write it on the
48 command line:
49 jrnl yesterday: I was walking and I found this big log.
51 The date and the following colon ("yesterday:") are optional. If
53 you leave them out, "now" will be used:
54 jrnl Then I rolled the log over.
56 Also, you can mark extra special entries ("star" them) with an
58 asterisk:
59 jrnl *And underneath was a tiny little stick.
61 Please note that asterisks might be a special character in your
63 shell, so you might have to escape them. When in doubt about es‐
64 caping, put quotes around your entire entry:
65 jrnl "saturday at 2am: *Then I was like 'That log had a child!'"
67 Searching:
69 To find entries from your journal, use any combination of the
70 below filters.
71 -on DATE
73 Show entries on this date
74 -today-in-history
76 Show entries of today over the years
77 -month DATE
79 Show entries on this month of any year
80 -day DATE
82 Show entries on this day of any month
83 -year DATE
85 Show entries of a specific year
86 -from DATE
88 Show entries after, or on, this date
89 -to DATE
91 Show entries before, or on, this date (alias: -until)
92 -contains TEXT
94 Show entries containing specific text (put quotes around text
95 with spaces)
96 -and Show only entries that match all conditions, like saying "x AND
98 y" (default: OR)
99 -starred
101 Show only starred entries (marked with *)
102 -n [NUMBER]
104 Show a maximum of NUMBER entries (note: '-n 3' and '-3' have the
105 same effect)
106 -not [TAG]
108 Exclude entries with this tag
109 Searching Options:
111 These help you do various tasks with the selected entries from
112 your search. If used on their own (with no search), they will
113 act on your entire journal
114 --edit Opens the selected entries in your configured editor
116 --delete
118 Interactively deletes selected entries
119 --format TYPE
121 Display selected entries in an alternate format. TYPE can be:
122 boxed, dates, fancy, json, markdown, md, pretty, sample, short,
123 tags, text, txt, xml, or yaml. Optional parameters: --file
124 FILENAME Write output to file instead of stdout
125 --tags Alias for '--format tags'. Returns a list of all tags and number
127 of occurences
128 --short
130 Show only titles or line containing the search tags
131 Config file override:
133 Apply a one-off override of the config file option
134 --config-override CONFIG_KV_PAIR CONFIG_KV_PAIR
136 Override configured key-value pair with CONFIG_KV_PAIR for this
137 command invocation only. Examples: - Use a different editor for
138 this jrnl entry, call: jrnl --config-override editor "nano" -
139 Override color selections jrnl --config-override colors.body
140 blue --configoverride colors.title green
141 Specifies alternate config to be used:
143 Applies alternate config for current session
144 --config-file CONFIG_FILE_PATH
146 Overrides default (created when first installed) config file for
147 this command only. Examples: - Use a work config file for this
148 jrnl entry, call: jrnl --config-file /home/user1/work_con‐
149 fig.yaml - Use a personal config file stored on a thumb drive:
150 jrnl --config-file /media/user1/my-thumbdrive/personal_con‐
151 fig.yaml
152 Thank you to all of our contributors! Come see the whole list of code
154 and financial contributors at https://github.com/jrnl-org/jrnl. And
155 special thanks to Bad Lip Reading for the Yoda joke in the Writing sec‐
156 tion above.
157
159 Copyright © 2012-2021 jrnl contributors
160 This is free software, and you are welcome to redistribute it under
162 certain conditions; for details, see: https://www.gnu.org/li‐
163 censes/gpl-3.0.html
164jrnl version v2.8.4 June 2022 JRNL(1)