Skip to content

Command Reference

All commands are available under the pkm binary.

CommandPurpose
pkm initCreate library internals and seed default types
pkm captureSave a quick fleeting note
pkm saveSave a structured note from a template
pkm indexRebuild the SQLite index from Markdown
pkm searchSearch indexed notes
pkm backlinksQuery incoming and outgoing links
pkm heatCompute and show related notes
pkm mocGenerate a Map of Content
pkm typeManage note types and templates

Most commands accept --scope:

Terminal window
--scope global
--scope project
--scope all

Write commands use global or project. Read commands can usually search all discovered libraries when --scope is omitted.

If notes changed outside pkm, run:

Terminal window
pkm index

Then search, backlinks, and heat operate on fresh data.