Collect your thoughts and notes without leaving the command line.
Find a file
Micah Jerome Ellison 5b029e6117
Documentation updates (#1032)
* Applying doc changes based on reviews of past several documentation PRs
* Update docs
  Clean up encryption docs
  Clean up security docs
  Delete export.md
  Make new formats.md and add to sidebar. Also add all of the built-in formats, and examples for each.
  Update mkdocs config for new files

* Fix broken docs links
* Correct incomplete sentences and markdown formatting issues
* Make overview a little more concise
* Update some command line arguments to latest version and make it a bit more concise
* Clean up unneeded TOML modifications and other scaffolding not needed for 3.9
* Revert "Clean up unneeded TOML modifications and other scaffolding not needed for 3.9"
  This reverts commit 13b4266ed1.
* Specify that brew is also the easiest way to install jrnl on Linux
* Update docs/security.md
* Update docs/recipes.md
* Doc updates:
- Remove import/export page, fold it into formats
- Rename security to privacy-and-security.md to avoid conflation w/ github security issues
- Various small cleanup and edits from PR review

Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>
2020-10-24 15:41:58 -07:00
.build Add support for Python 3.9 build testing (#1018) 2020-08-17 17:46:13 -07:00
.github Update github issue templates to use new diagnostic command (#1022) 2020-08-08 11:46:16 -07:00
docs Documentation updates (#1032) 2020-10-24 15:41:58 -07:00
features Add display format option to config file. (#1050) 2020-10-17 18:53:34 -07:00
jrnl Add display format option to config file. (#1050) 2020-10-17 18:53:34 -07:00
tests Clean up help screen, get rid of util.py (#1027) 2020-08-22 11:40:39 -07:00
.gitattributes Ensure test data is always checked out with LF line endings (#965) 2020-05-27 14:08:48 -07:00
.github_changelog_generator update changelog generator config to include closed issues 2020-10-17 19:30:18 -07:00
.gitignore Add extended metadata support for DayOne Classic (#928) 2020-06-06 12:41:15 -07:00
.travis.yml Add support for Python 3.9 and fix 3.9 build (#1054) 2020-10-10 17:33:08 -07:00
CHANGELOG.md Update changelog [ci skip] 2020-10-18 03:00:49 +00:00
CODE_OF_CONDUCT.md Update the code of conduct (#913) 2020-04-18 12:35:46 -07:00
CONTRIBUTING.md Correct typos in CONTRIBUTING.md (#1040) 2020-09-05 10:53:10 -07:00
issue_template.md Clean up templates and issues (#954) 2020-05-23 15:58:04 -07:00
LICENSE.md Upgrade license to GPLv3 (#918) 2020-04-18 13:31:25 -07:00
Makefile Make behave output more concise when running make test (#988) 2020-06-27 17:51:31 -07:00
mkdocs.yml Documentation updates (#1032) 2020-10-24 15:41:58 -07:00
poetry.lock Add support for Python 3.9 and fix 3.9 build (#1054) 2020-10-10 17:33:08 -07:00
pyproject.toml Increment version to v2.5-beta 2020-10-17 22:23:55 +00:00
README.md Documentation updates (#1032) 2020-10-24 15:41:58 -07:00
readthedocs.yml Fix readthedocs.io build process (#1004) 2020-07-25 16:34:17 -07:00

jrnl Build Status Downloads Version

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:

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.