A CLI tool for managing project-specific runbooks and manuals stored in .pm/ directories.

Homebrew:

brew install hojooneum/tap/pm

Go:

go install github.com/hojooneum/pm@latest

# Initialize a project manual in the current directory
pm init

# List all sections
pm list

# Open a specific section
pm open deploy

# Edit a section in your editor
pm edit deploy

# Search across all sections
pm search kubernetes

Running pm with no arguments shows a project summary, or prompts you to initialize if no .pm/ directory exists.

pm init                          # Use the default template
pm init --template minimal       # Use a built-in preset
pm init --template my-tmpl.json  # Use a custom JSON template
pm init --list-templates         # List available presets

pm stores project documentation in a .pm/ directory at your project root.

Groups are subdirectories under .pm/ (e.g., core/, custom/). They organize sections by category. core sorts first, custom sorts last, and everything else is alphabetical.

Sections are markdown files within groups. Each section can have YAML frontmatter with title, description, and tags:

---
title: Deployment Guide
description: Step-by-step deployment procedures
tags: deploy, release
---

# Deployment Guide

Your content here...

Section names are resolved case-insensitively, so pm open Deploy and pm open deploy both work.

Templates define which sections to scaffold when running pm init.

Built-in presets:

Custom templates can be provided as JSON files:

{
  "name": "my-template",
  "sections": [
    {
      "name": "overview",
      "group": "core",
      "title": "Project Overview",
      "description": "High-level summary",
      "tags": ["overview"]
    }
  ]
}

Section names must match [a-z0-9][a-z0-9-]*.

MIT