Skip to content
pkm

Team Notes

pkm is designed for git-friendly team workflows. Markdown is source of truth. SQLite is a local cache.

Commit These

Section titled “Commit These”
Inbox/
Notes/
MOCs/
.pkm/types/
.pkm/types.json

Do Not Commit This

Section titled “Do Not Commit This”
.pkm/.index/

The index is rebuilt from Markdown files.

Pull Workflow

Section titled “Pull Workflow”
Terminal window
git pull
pkm index --scope project
pkm search "thing I need"

Template Workflow

Section titled “Template Workflow”

Keep custom type templates in the project library when the type is specific to the repo. Keep reusable types in the global library.

Terminal window
pkm type add incident --template incident-template.md --dir Notes/Incidents --scope project

Review Workflow

Section titled “Review Workflow”

Because notes are Markdown, reviews are normal code reviews. Prefer small, link-rich notes over huge documents that are hard to diff.