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

NAME

6       jrnl - manual page for jrnl version v2.8.1
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]]
14              [--edit] [--delete] [--format TYPE] [--tags]  [--short]  [--con‐
15              fig-override CONFIG_KV_PAIR CONFIG_KV_PAIR] [...]
16
17       Collect your thoughts and notes without leaving the command line
18
19   Optional Arguments:
20       --debug
21              Print information useful for troubleshooting
22
23   Standalone Commands:
24              These  commands  will exit after they complete. You may only run
25              one at a time.
26
27       --help Show this help message
28
29       --version
30              Print version information
31
32       --list List all configured journals
33
34       --encrypt
35              Encrypt selected journal with a password
36
37       --decrypt
38              Decrypt selected journal and store it in plain text
39
40       --import
41              Import  entries  from  another  journal.   Optional  parameters:
42              --file  FILENAME (default: uses stdin) --format [jrnl] (default:
43              jrnl)
44
45   Writing:
46              To add a new entry into your journal, simply  write  it  on  the
47              command line:
48
49              jrnl yesterday: I was walking and I found this big log.
50
51              The date and the following colon ("yesterday:") are optional. If
52              you leave them out, "now" will be used:
53
54              jrnl Then I rolled the log over.
55
56              Also, you can mark extra special entries ("star" them)  with  an
57              asterisk:
58
59              jrnl *And underneath was a tiny little stick.
60
61              Please  note that asterisks might be a special character in your
62              shell, so you might have to escape them. When in doubt about es‐
63              caping, put quotes around your entire entry:
64
65              jrnl "saturday at 2am: *Then I was like 'That log had a child!'"
66
67   Searching:
68              To  find  entries  from your journal, use any combination of the
69              below filters.
70
71       -on DATE
72              Show entries on this date
73
74       -today-in-history
75              Show entries of today over the years
76
77       -month DATE
78              Show entries on this month of any year
79
80       -day DATE
81              Show entries on this day of any month
82
83       -year DATE
84              Show entries of a specific year
85
86       -from DATE
87              Show entries after, or on, this date
88
89       -to DATE
90              Show entries before, or on, this date (alias: -until)
91
92       -contains TEXT
93              Show entries containing specific text (put  quotes  around  text
94              with spaces)
95
96       -and   Show  only entries that match all conditions, like saying "x AND
97              y" (default: OR)
98
99       -starred
100              Show only starred entries (marked with *)
101
102       -n [NUMBER]
103              Show a maximum of NUMBER entries (note: '-n 3' and '-3' have the
104              same effect)
105
106       -not [TAG]
107              Exclude entries with this tag
108
109   Searching Options:
110              These  help  you do various tasks with the selected entries from
111              your search.  If used on their own (with no search),  they  will
112              act on your entire journal
113
114       --edit Opens the selected entries in your configured editor
115
116       --delete
117              Interactively deletes selected entries
118
119       --format TYPE
120              Display  selected  entries in an alternate format.  TYPE can be:
121              boxed, dates, fancy, json, markdown, md, pretty, sample,  short,
122              tags,  text,  txt,  xml,  or  yaml.  Optional parameters: --file
123              FILENAME Write output to file instead of stdout
124
125       --tags Alias for '--format tags'. Returns a list of all tags and number
126              of occurences
127
128       --short
129              Show only titles or line containing the search tags
130
131   Config file override:
132              Apply a one-off override of the config file option
133
134       --config-override CONFIG_KV_PAIR CONFIG_KV_PAIR
135              Override  configured key-value pair with CONFIG_KV_PAIR for this
136              command invocation only.  Examples: - Use a different editor for
137              this  jrnl  entry, call: jrnl --config-override editor: "nano" -
138              Override color  selections  jrnl  --config-override  colors.body
139              blue --configoverride colors.title green
140
141       Thank  you  to all of our contributors! Come see the whole list of code
142       and financial  contributors  at  https://github.com/jrnl-org/jrnl.  And
143       special thanks to Bad Lip Reading for the Yoda joke in the Writing sec‐
144       tion above.
145

147       Copyright © 2012-2021 jrnl contributors
148
149       This is free software, and you are welcome  to  redistribute  it  under
150       certain   conditions;   for   details,   see:   https://www.gnu.org/li‐
151       censes/gpl-3.0.html
152
153
154
155jrnl version v2.8.1               April 2021                           JRNL(1)
Impressum