Quick Start

1. Initialize A Library

Use a global library for personal cross-project knowledge:

pkm init --scope global

Inside a git repo, use a project library for repo-specific notes:

pkm init --scope project

2. Capture A Thought

pkm capture "look into event schema changes"

Captures land in Inbox/ as timestamped fleeting notes.

3. Save A Structured Note

pkm save --title "Architecture Decision: Switch to Kafka" --tags architecture,kafka

Structured notes use registered type templates and are saved into the type’s configured directory.

4. Rebuild The Index

pkm index

Index after creating, editing, moving, or pulling notes. The SQLite database is a derived cache.

5. Search And Navigate

pkm search kafka
pkm search --tags architecture
pkm backlinks "Architecture Decision: Switch to Kafka"
pkm heat compute
pkm heat show "Architecture Decision: Switch to Kafka"

What Gets Created

library root/
├── Inbox/
├── Notes/
├── MOCs/
└── .pkm/
    ├── types/
    ├── types.json
    └── .index/pkm.db