otty / dotfiles

All tools/jrnl

jrnl

Collect your thoughts and notes without leaving the command line.

Detected by jrnl | macOS, Linux, Windows |jrnl.sh

Sync it jrnl.toml

Sync rules

What travels, what stays, what never leaves

jrnl in your home directory Every rule on this page, by file

journals.*.journal

Each machine keeps its own copy of these.

journals.*.journal

Each machine keeps its own copy of these.

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/jrnl.tomlThe file this page is generated from

id = "jrnl"

name = "jrnl"

homepage = "https://jrnl.sh"

description = "Collect your thoughts and notes without leaving the command line."

# The jrnl mark, the favicon the project's documentation theme carries.

icon = "https://raw.githubusercontent.com/jrnl-org/jrnl/develop/docs_theme/img/favicon.svg"

detect = ["jrnl"]

# https://jrnl.sh/en/stable/reference-config-file/ — the config file is

# "$XDG_CONFIG_HOME/jrnl/jrnl.yaml", "~/.config/jrnl/jrnl.yaml" when the

# variable is unset, and "%USERPROFILE%\.config\jrnl\jrnl.yaml" on Windows.

# Both spellings are listed because jrnl is one of the few tools where they are

# not the same place: it reads $XDG_CONFIG_HOME on every platform, which is what

# [configHome] means, but on Windows [configHome] resolves to %APPDATA% while

# jrnl keeps the dotted path under the profile root. Naming only one of the two

# would leave either XDG users or Windows users pointed at a file jrnl never

# opens; on a default Unix machine they resolve to the same file, which costs

# nothing.

paths = [

"[configHome]/jrnl/jrnl.yaml",

"~/.config/jrnl/jrnl.yaml",

]

exclude = []

# The journals themselves are text (or encrypted) files elsewhere on disk, at

# whatever path the user chose; this entry names only the config.

secret = []

# https://jrnl.sh/en/stable/encryption/ — "when encrypting a journal, jrnl asks

# whether you would like to store the password in your system's keychain", and

# the config file's `encrypt` key "merely says whether or not your journal is

# encrypted". So there is no password in jrnl.yaml and no secret_paths rule to

# write.

# The same reference page: "journals — Describes each journal used by jrnl. Each

# indented key after this key is the name of a journal", and a journal's

# `journal` key is the absolute path to the file or folder holding it on this

# machine. jrnl also accepts a shorthand where the journal name maps straight to

# the path instead of to a block; that form cannot be told apart from a nested

# block by key path alone, so only the explicit key is named here. Everything

# else in the file — timeformat, tagsymbols, colors, display_format, linewrap,

# default_hour — is a preference the user wants everywhere. The journal path is

# where the user's own writing sits, which is the one thing they would need

# back after rebuilding this machine, so it is kept: backup.

[[machine_lines]]

file = ["[configHome]/jrnl/jrnl.yaml", "~/.config/jrnl/jrnl.yaml"]

match = { key_path = ["journals.*.journal"] }

scope = "backup"

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/jrnl. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits journals.*.journal and journals.*.journal for you — that part is Otty’s own sync, or a template you write by hand.