1JRNL(1) User Commands JRNL(1)
2
6 jrnl - manual page for jrnl v4.1
7
9 usage: __main__.py [--debug] [--help] [--version] [--list] [--encrypt]
10 [--decrypt] [--import] [--template TEMPLATE] [-on DATE] [-to‐
12 day-in-history] [-month DATE] [-day DATE] [-year DATE] [-from
13 DATE] [-to DATE] [-contains TEXT] [-and] [-starred] [-tagged]
14 [-n [NUMBER]] [-not [TAG/FLAG]] [--edit] [--delete]
15 [--change-time [DATE]] [--format TYPE] [--tags] [--short]
16 [--config-override CONFIG_KV_PAIR CONFIG_KV_PAIR] [--config-file
17 CONFIG_FILE_PATH] [...]
18 Collect your thoughts and notes without leaving the command line
20 Optional Arguments:
22 --debug
23 Print information useful for troubleshooting
24 Standalone Commands:
26 These commands will exit after they complete. You may only run
27 one at a time.
28 --help Show this help message
30 --version
32 Print version information
33 --list List all configured journals. Optional parameters: --format
35 [json or yaml]
36 --encrypt
38 Encrypt selected journal with a password
39 --decrypt
41 Decrypt selected journal and store it in plain text
42 --import
44 Import entries from another journal. Optional parameters:
45 --file FILENAME (default: uses stdin) --format [jrnl] (default:
46 jrnl)
47 Writing:
49 To add a new entry into your journal, simply write it on the
50 command line:
51 jrnl yesterday: I was walking and I found this big log.
53 The date and the following colon ("yesterday:") are optional. If
55 you leave them out, "now" will be used:
56 jrnl Then I rolled the log over.
58 Also, you can mark extra special entries ("star" them) with an
60 asterisk:
61 jrnl *And underneath was a tiny little stick.
63 Please note that asterisks might be a special character in your
65 shell, so you might have to escape them. When in doubt about es‐
66 caping, put quotes around your entire entry:
67 jrnl "saturday at 2am: *Then I was like 'That log had a child!'"
69 --template TEMPLATE
71 Path to template file. Can be a local path, absolute path, or a
72 path relative to $XDG_DATA_HOME/jrnl/templates/
73 Searching:
75 To find entries from your journal, use any combination of the
76 below filters.
77 -on DATE
79 Show entries on this date
80 -today-in-history
82 Show entries of today over the years
83 -month DATE
85 Show entries on this month of any year
86 -day DATE
88 Show entries on this day of any month
89 -year DATE
91 Show entries of a specific year
92 -from DATE
94 Show entries after, or on, this date
95 -to DATE
97 Show entries before, or on, this date (alias: -until)
98 -contains TEXT
100 Show entries containing specific text (put quotes around text
101 with spaces)
102 -and Show only entries that match all conditions, like saying "x AND
104 y" (default: OR)
105 -starred
107 Show only starred entries (marked with *)
108 -tagged
110 Show only entries that have at least one tag
111 -n [NUMBER]
113 Show a maximum of NUMBER entries (note: '-n 3' and '-3' have the
114 same effect)
115 -not [TAG/FLAG]
117 If passed a string, will exclude entries with that tag. Can be
118 also used before -starred or -tagged flags, to exclude starred
119 or tagged entries respectively.
120 Searching Options:
122 These help you do various tasks with the selected entries from
124 your search. If used on their own (with no search), they will
125 act on your entire journal
126 --edit Opens the selected entries in your configured editor
128 --delete
130 Interactively deletes selected entries
131 --change-time [DATE]
133 Change timestamp for selected entries (default: now)
134 --format TYPE
136 Display selected entries in an alternate format. TYPE can be:
137 boxed, dates, fancy, json, markdown, md, pretty, short, tags,
138 text, txt, xml, or yaml. Optional parameters: --file FILENAME
139 Write output to file instead of stdout
140 --tags Alias for '--format tags'. Returns a list of all tags and number
142 of occurrences
143 --short
145 Show only titles or line containing the search tags
146 Config file override:
148 Apply a one-off override of the config file option
149 --config-override CONFIG_KV_PAIR CONFIG_KV_PAIR
151 Override configured key-value pair with CONFIG_KV_PAIR for this
152 command invocation only. Examples: - Use a different editor for
153 this jrnl entry, call: jrnl --config-override editor "nano" -
154 Override color selections jrnl --config-override colors.body
155 blue --configoverride colors.title green
156 Specifies alternate config to be used:
158 Applies alternate config for current session
159 --config-file CONFIG_FILE_PATH
161 Overrides default (created when first installed) config file for
162 this command only. Examples: - Use a work config file for this
163 jrnl entry, call: jrnl --config-file /home/user1/work_con‐
164 fig.yaml - Use a personal config file stored on a thumb drive:
165 jrnl --config-file /media/user1/my-thumbdrive/personal_con‐
166 fig.yaml
167 We gratefully thank all contributors! Come see the whole list of code
169 and financial contributors at https://github.com/jrnl-org/jrnl And spe‐
170 cial thanks to Bad Lip Reading for the Yoda joke in the Writing section
171 above :)
172
174 Copyright © 2012-2023 jrnl contributors
175 This is free software, and you are welcome to redistribute it under
177 certain conditions; for details, see: https://www.gnu.org/li‐
178 censes/gpl-3.0.html
179jrnl v4.1 November 2023 JRNL(1)