Reading the repo
Opening the box…
Reading the repo
Opening the box…
Assembly instructions
Collect your thoughts and notes without leaving the command line.
Saved setup from 11 h ago
Will it work on macOS?
docs/installation.mdThe easiest way to install jrnl is using
pipx
with Python 3.11+:
pipx install jrnl
!!! tip
Do not use sudo while installing jrnl. This may lead to path issues.
The first time you run jrnl you will be asked where your journal file
should be created and whether you wish to encrypt it.
To make a new entry, just type
jrnl yesterday: Called in sick. Used the time to clean, and spent 4h on writing my book.
and hit return. yesterday: will be interpreted as a time stamp.
Everything until the first sentence mark (.?!:) will be interpreted as
the title, 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 spent 4h on writing 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.
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install
git clone https://github.com/jrnl-org/jrnl.git cd jrnl
Node.js LTS (no version pinned), Python >=3.11.0,<3.15
# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm) nvm install --lts brew install python@3.11 pipx install poetry
npm ci poetry install
poetry run pytest
No reports for macOS yet.
GitManual AI Agent reads the 10 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.