Project Memory Companion

Optional Obsidian interface for Project Memory vaults.

Features

• Review pending or deferred Promotion Inbox candidates.
• Preview each candidate's evidence and proposed Markdown change before deciding.
• Compare existing and proposed claims side by side when a candidate conflicts with durable knowledge.
• Display the latest portable Health Report and its structural findings on desktop or mobile.
• Filter candidates by status, operation, or text and safely defer or reject an explicit selection in bulk; bulk approval is unavailable.
• Show a chronological knowledge timeline from durable-note updates and candidate approval/application events.
• Optionally show one local startup notification for approved-but-unapplied candidates, application problems, and overdue reviews.
• Mark candidates approved, rejected, or deferred without silently applying semantic changes.
• Review shared team notes using Project Memory frontmatter.
• See overdue reviews, incomplete supersession links, and coverage maps needing attention.
• Limit the dashboard to one vault-relative project folder.

The plugin operates only on local vault files. It has no network integration, account, telemetry, background service, or external storage.

Local installation

Copy main.js, manifest.json, and styles.css into:

<vault>/.obsidian/plugins/project-memory-companion/

Reload Obsidian, enable Project Memory Companion under Community plugins, and use the brain-circuit ribbon icon or the Project Memory Companion: Open dashboard command.

Approving a Promotion Inbox candidate records who approved it, when it was approved, and a fingerprint of the reviewed proposal. It does not apply the proposed content. Ask Codex to apply approved Project Memory candidates after review. Codex records applying, then applied, conflict, or failed, including the target and outcome metadata.

Privacy and permissions

The companion reads Markdown and metadata inside the current Obsidian vault. It writes only candidate status fields and explicit team review frontmatter when the user selects an action. Its local settings contain a vault-relative project folder and optional reviewer alias.

It does not access files outside the vault, use the network, install updates, collect telemetry, display advertising, require an account, or read Codex transcripts.

Development

npm ci
npm test
npm run build
npm run lint

The production build creates main.js. The GitHub workflows test supported Node versions and create draft releases with build provenance attestations.

Release

Use a strict x.y.z version with no v prefix. Update the package version so the version script synchronizes manifest.json and versions.json, then push the matching tag. The release workflow verifies the tag, runs all checks, and attaches main.js, manifest.json, and styles.css to a draft release.

Licence

MIT. See LICENSE.