* First draft of command line reference, mostly pulled from help screen * Add first draft of config file reference, mostly pulled from advanced.md * Clean up config file doc for readability * Add --config-file and remove examples from CLI reference * Add warning about time zone in timeformat * More small changes, and adding template config keyword * Cleaning up and re-ordering config file reference * Clean up reference and anything else from advanced documentation that can live elsewhere and linking to config file reference wherever config file is mentioned * Fix syntax highlighting in command line reference, clean up content a bit, include --diagnostic * Mention version config key * Apply minor changes suggested in PR review * Rename "recipes" to "Tips and Tricks", pull "External Editors" out of it into its own page, and redirect old recipes link to tips-and-tricks * Revert broken mkdocs-redirects usage from last commit |
||
---|---|---|
.build | ||
.github | ||
docs | ||
docs_theme | ||
jrnl | ||
tests | ||
.gitattributes | ||
.gitignore | ||
CHANGELOG.md | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
issue_template.md | ||
LICENSE.md | ||
Makefile | ||
mkdocs.yml | ||
poetry.lock | ||
pyproject.toml | ||
README.md | ||
readthedocs.yml | ||
SECURITY.md |
jrnl

To get help, submit an issue on Github.
jrnl
is a simple journal application for the command line.
You can use it to easily create, search, and view journal entries. Journals are stored as human-readable plain text, and can also be encrypted using AES encryption.
In a Nutshell
To make a new entry, just enter
jrnl yesterday: Called in sick. Used the time to clean the house and write my
book.
yesterday:
is interpreted by jrnl
as a timestamp. Everything until the
first sentence ending (either .
, ?
, or !
) is interpreted as the title, and
the rest as the body. In your journal file, the result will look like this:
[2012-03-29 09:00] Called in sick.
Used the time to clean the house and write my book.
If you just call jrnl
, you will be prompted to compose your entry - but you
can also configure jrnl to use your external editor.
For more information, please read the documentation.
Contributors
Maintainers
Our maintainers help keep the lights on for the project:
- Jonathan Wren (wren)
- Micah Ellison (micahellison)
Please thank them if you like jrnl
!
Code Contributors
This project is made with love by the many fabulous people who have contributed.
jrnl
couldn't exist without each and every one of you!
If you'd also like to help make jrnl
better, please see our contributing
documentation.
Financial Backers
Another way show support is through direct financial contributions. These funds
go to covering our costs, and are a quick way to show your appreciation for
jrnl
.
Become a financial contributor and help us sustain our community.