Skip to content

rowanchase/jrnl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jnrl

An embarrassingly simple note taking CLI tool.

All this does is create and/or open a markdown file in your $EDITOR with a title header already populated. When you save and close the file it will commit it. That's it.

NOTE

This is just for me, so there's a lot of hard coded values at the moment, eg. the root folder of your notes will always be "$HOME/journal/" and your editor will be neovim.

Configuration

Create a configuration file at $XDG_HOME/jrnl/config.toml.

The config file is expected to contain a TOML table representing a "profile". The only required key at the moment under each profile is a "root" key, which is the root directory for your journal.

An example file might look like:

[personal]
root = "/home/me/journal"

[work]
root = "/home/me/work-repository/docs"

The active profile is selected by setting the JRNL_PROFILE environment variable. eg. export JRNL_PROFILE=personal

Usage

Make a note for today:

jrnl

This will create a note at {root}/{year}/{month}/{day}.md with the header eg. # Monday 30 June 2025

Make a note for another date:

jrnl date 2025 6 30

This will create a note at {root}/2025/6/30.md with the header # Monday 30 June 2025

Make a namespace'd note:

jrnl ns pets dogs shepherds swiss

This will create a note at {root}/pets/dogs/shepherds/swiss.md with the header # pets.dogs.shepherds.swiss

Complimentary tools

Marksman

A Markdown LSP will help you link between and navigate your notes.

git-remote-gcrypt

Simple tool to encrypt your repo, there's full instructions here.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages