Welcome to Procnote¶

Procnote is an event-sourced desktop app for executing and auditing step-by-step procedures. It replaces paper checklists and ad-hoc spreadsheets with a structured, crash-safe execution engine backed by append-only event logs.

What Does Procnote Do?¶

1. Define procedures as Markdown templates with checkboxes, data inputs, and prose instructions.
2. Execute procedures step by step in a desktop UI, recording every action as an immutable event.
3. Audit and review completed executions with full event history and revert capabilities.

Quick Example¶

A procedure template is a Markdown file with YAML frontmatter:

---
id: INSP-001
title: "Visual Inspection - PCB Assembly"
version: "1.0"
---

## Prepare workspace

- [ ] Wear ESD wrist strap
- [ ] Clean inspection surface

## Inspect solder joints

- [ ] No cold solder joints
- [ ] No solder bridges

## Record results

​```inputs

- id: result
  type: selection
  label: "Inspection result"
  options: ["Pass", "Fail", "Conditional pass"]
- id: notes
  type: text
  label: "Inspector notes"
  ​```

Launch Procnote with a workspace directory, just like code <path> for VS Code:

procnote /path/to/my-workspace

Procnote discovers all template.md files in the workspace, guides the operator through each step, captures checkbox states and input values, and writes every action to an append-only event log.

Getting Started¶