Skip to content
pkm

Project Library

A project library lives at the git root. Use it for notes that only make sense in the context of that repository.

Initialize

Section titled “Initialize”
Terminal window
pkm init --scope project

Good Project Notes

Section titled “Good Project Notes”
  • Architecture decisions
  • Data pipeline docs
  • Deployment runbooks
  • Ticket summaries
  • Incident notes
  • Local conventions

Example

Section titled “Example”
Terminal window
pkm save --title "DAG: user_events_daily" --type dag --tags dag,events --scope project
pkm index --scope project
pkm heat compute --scope project

Project libraries are especially useful for onboarding. A teammate can pull the repo, run pkm index, and search the Markdown knowledge already committed with the code.

Keep Global And Project Separate

Section titled “Keep Global And Project Separate”

Use project scope when the note names repo-specific systems, paths, credentials processes, or deployment behavior. Use global scope when the idea is reusable across projects.