notes

Collective memory, encrypted.

Write normal Markdown under notes/. Notes keeps readable names in your working tree while Git stores encrypted content under opaque filenames. Explicit commands handle the moments where those two views meet: setup, review, staging, commits, and conflicts.

Install

Install the command for your user:

shiv install notes

Or declare it for a project:

[plugins]
shiv = "https://github.com/KnickKnackLabs/vfox-shiv"

[tools]
"shiv:notes" = "0.8"

mise install

Run

# Initialize encrypted notes and install the Git hooks.
notes setup --yes

# Work with ordinary Markdown.
notes new --slug project-plan --title "Project plan" --tags planning
notes search "project plan"

# Review and commit through the readable/obfuscated boundary.
notes changes --summary
notes commit -m "notes: add project plan" notes/project-plan.md
notes diff HEAD~1..HEAD

Operational notes

• Join an existing encrypted repo with notes setup --yes --unlock.
• setup, lock, install-hooks, and unlock --force require explicit confirmation.
• Prefer notes commit for note-only work; use notes stage when you need manual Git control.
• Before publishing a ref, run notes verify-blobs --ref HEAD --strict to prove its managed blobs are encrypted and local note changes are absent.
• notes lock currently locks every git-crypt path in the repository, not only notes/.
• Use notes conflicts or notes merge --dry-run to materialize readable conflict artifacts.

Documentation

Run notes --help for the complete command surface. See CONTRIBUTING.md for repository structure, encryption safety boundaries, and validation.

---

Tiny encrypted filing cabinet, very serious about labels.

Generated with readme