1JRNL(1)                          User Commands                         JRNL(1)
2
3
4

NAME

6       jrnl - manual page for jrnl version v3.0
7

DESCRIPTION

9       usage: __main__.py [--debug] [--help] [--version] [--list] [--encrypt]
10
11              [--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] [--edit]
14              [--delete]  [--change-time  [DATE]]  [--format  TYPE]   [--tags]
15              [--short]   [--config-override   CONFIG_KV_PAIR  CONFIG_KV_PAIR]
16              [--config-file CONFIG_FILE_PATH] [...]
17
18       Collect your thoughts and notes without leaving the command line
19
20   Optional Arguments:
21       --debug
22              Print information useful for troubleshooting
23
24   Standalone Commands:
25              These commands will exit after they complete. You may  only  run
26              one at a time.
27
28       --help Show this help message
29
30       --version
31              Print version information
32
33       --list List all configured journals
34
35       --encrypt
36              Encrypt selected journal with a password
37
38       --decrypt
39              Decrypt selected journal and store it in plain text
40
41       --import
42              Import  entries  from  another  journal.   Optional  parameters:
43              --file FILENAME (default: uses stdin) --format [jrnl]  (default:
44              jrnl)
45
46   Writing:
47              To  add  a  new  entry into your journal, simply write it on the
48              command line:
49
50              jrnl yesterday: I was walking and I found this big log.
51
52              The date and the following colon ("yesterday:") are optional. If
53              you leave them out, "now" will be used:
54
55              jrnl Then I rolled the log over.
56
57              Also,  you  can mark extra special entries ("star" them) with an
58              asterisk:
59
60              jrnl *And underneath was a tiny little stick.
61
62              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
66              jrnl "saturday at 2am: *Then I was like 'That log had a child!'"
67
68   Searching:
69              To find entries from your journal, use any  combination  of  the
70              below filters.
71
72       -on DATE
73              Show entries on this date
74
75       -today-in-history
76              Show entries of today over the years
77
78       -month DATE
79              Show entries on this month of any year
80
81       -day DATE
82              Show entries on this day of any month
83
84       -year DATE
85              Show entries of a specific year
86
87       -from DATE
88              Show entries after, or on, this date
89
90       -to DATE
91              Show entries before, or on, this date (alias: -until)
92
93       -contains TEXT
94              Show  entries  containing  specific text (put quotes around text
95              with spaces)
96
97       -and   Show only entries that match all conditions, like saying "x  AND
98              y" (default: OR)
99
100       -starred
101              Show only starred entries (marked with *)
102
103       -n [NUMBER]
104              Show a maximum of NUMBER entries (note: '-n 3' and '-3' have the
105              same effect)
106
107       -not TAG
108              Exclude entries with this tag
109
110   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
115       --edit Opens the selected entries in your configured editor
116
117       --delete
118              Interactively deletes selected entries
119
120       --change-time [DATE]
121              Change timestamp for seleted entries (default: now)
122
123       --format TYPE
124              Display selected entries in an alternate format.  TYPE  can  be:
125              boxed,  dates,  fancy,  json, markdown, md, pretty, short, tags,
126              text, txt, xml, or yaml.  Optional parameters:  --file  FILENAME
127              Write output to file instead of stdout
128
129       --tags Alias for '--format tags'. Returns a list of all tags and number
130              of occurences
131
132       --short
133              Show only titles or line containing the search tags
134
135   Config file override:
136              Apply a one-off override of the config file option
137
138       --config-override CONFIG_KV_PAIR CONFIG_KV_PAIR
139              Override configured key-value pair with CONFIG_KV_PAIR for  this
140              command invocation only.  Examples: - Use a different editor for
141              this jrnl entry, call: jrnl --config-override  editor  "nano"  -
142              Override  color  selections  jrnl  --config-override colors.body
143              blue --configoverride colors.title green
144
145   Specifies alternate config to be used:
146              Applies alternate config for current session
147
148       --config-file CONFIG_FILE_PATH
149              Overrides default (created when first installed) config file for
150              this  command  only. Examples: - Use a work config file for this
151              jrnl  entry,  call:  jrnl  --config-file   /home/user1/work_con‐
152              fig.yaml  -  Use a personal config file stored on a thumb drive:
153              jrnl   --config-file    /media/user1/my-thumbdrive/personal_con‐
154              fig.yaml
155
156       Thank  you  to all of our contributors! Come see the whole list of code
157       and financial  contributors  at  https://github.com/jrnl-org/jrnl.  And
158       special thanks to Bad Lip Reading for the Yoda joke in the Writing sec‐
159       tion above.
160
162       Copyright © 2012-2022 jrnl contributors
163
164       This is free software, and you are welcome  to  redistribute  it  under
165       certain   conditions;   for   details,   see:   https://www.gnu.org/li
166       censes/gpl-3.0.html
167
168
169
170jrnl version v3.0                 August 2022                          JRNL(1)
Impressum