Collect your thoughts and notes without leaving the command line.
Find a file
samuelgregorovic ae009099ed
Add --config-file argument to use alternate config file at runtime (#1290)
* added new CLI argument option --config-file

* pass argument and fetch alt config file if specified

* argparse argument setting update

* argument alias --cf added

* documentation update - usage of CLI argument

* fixed name-clash + unit tests

* feature test added

* #1170-alternate-config-file: Auto stash before rebase of "refs/heads/#1170-alternate-config-file"

* Update docs/advanced.md

Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>

* BDD tests added

* Begin migrating/rewording --cf tests in pytest-bdd.

Uses current directory instead of deep directory structure, but requires a given for each config file referenced

* Fix issue where specifying a config-file that needs to be upgraded ended up upgrading the user config file instead

* Uncomment and rework remaining tests for pytest-bdd instead of behave

* Fix copytree for Python 3.7 (which doesn't support dirs_exist_ok)

* Minor fixes to alternative config examples

* Remove behave tests (behave is no longer in use)

* Move config file unit test to unit test dir and use pytext path fixture instead of current directory to find test data

* Use explicit "given the config exists" for copying config files instead of shoehorning in "given we use the config" twice

* Change when/when to when/and

* Clarify scenarios and fix indentation

* Confirm primary config file isn't modified when encrypting/decrypting a journal in an alternate config file

* Remove try/except on copytree since I'm no longer using the same

Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>
Co-authored-by: Micah Jerome Ellison <micah.jerome.ellison@gmail.com>
2021-11-06 14:12:34 -07:00
.build Add changelog generation workflow to github actions (#1086) 2020-11-21 11:21:19 -08:00
.github Add more steps to pytest, fully remove behave (#1347) 2021-10-09 12:10:08 -07:00
docs Add --config-file argument to use alternate config file at runtime (#1290) 2021-11-06 14:12:34 -07:00
docs_theme Migrate contributing.md to docs site (#1266) 2021-10-16 15:21:49 -07:00
jrnl Add --config-file argument to use alternate config file at runtime (#1290) 2021-11-06 14:12:34 -07:00
tests Add --config-file argument to use alternate config file at runtime (#1290) 2021-11-06 14:12:34 -07:00
.gitattributes Fix annoying poetry-generated Windows line endings 2021-07-03 15:49:18 -07:00
.gitignore Move remaining tests from behave to pytest (#1346) 2021-10-02 13:31:21 -07:00
CHANGELOG.md Update changelog [ci skip] 2021-11-06 20:39:19 +00:00
CODE_OF_CONDUCT.md Update the code of conduct (#913) 2020-04-18 12:35:46 -07:00
CONTRIBUTING.md Migrate contributing.md to docs site (#1266) 2021-10-16 15:21:49 -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 Add more steps to pytest, fully remove behave (#1347) 2021-10-09 12:10:08 -07:00
mkdocs.yml Migrate contributing.md to docs site (#1266) 2021-10-16 15:21:49 -07:00
poetry.lock Bump pytest-bdd from 4.1.0 to 5.0.0 (#1368) 2021-11-06 13:37:54 -07:00
pyproject.toml Switch to poetry-core (#1359) 2021-10-23 12:17:32 -07:00
README.md Fix splash image for PyPi (I hope) and add changelog badge (#1339) 2021-09-18 12:31:45 -07:00
readthedocs.yml Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 (#1105) 2020-12-12 12:05:12 -08:00
SECURITY.md Add first draft of security.md (#1299) 2021-07-17 12:01:59 -07:00

jrnl Testing Downloads Version Homebrew Gitter Changelog

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.