Compound-engineering-plugin ce-proof
Create, share, view, comment on, edit, and run human-in-the-loop review loops over markdown documents via Proof — the collaborative markdown editor and renderer at proofeditor.ai (also called "Proof editor"). Use this skill whenever the user wants to view or render a local markdown file in Proof for easier reading, share a markdown file to Proof to get a shareable URL, iterate on a Proof doc collaboratively, comment on or suggest edits in a Proof doc, HITL a spec/plan/draft for human review, sync a Proof doc back to local, or when given a proofeditor.ai URL. Common phrasings include "view this in proof", "render this markdown in proof", "open this md file in proof", "share it to proof", "share to proof editor", "iterate with proof", "HITL this doc". Upstream handoffs from ce-brainstorm / ce-ideate / ce-plan for human review also belong here. Match these intents even when the user doesn't name Proof, as long as they clearly want a rendered/shared markdown surface. Do NOT trigger on "proof" meaning evidence, a mathematical/logical proof, burden of proof, proof-of-concept, or a bare "proofread this" request where the model is expected to review text inline.
git clone https://github.com/EveryInc/compound-engineering-plugin
T=$(mktemp -d) && git clone --depth=1 https://github.com/EveryInc/compound-engineering-plugin "$T" && mkdir -p ~/.claude/skills && cp -r "$T/plugins/compound-engineering/skills/ce-proof" ~/.claude/skills/everyinc-compound-engineering-plugin-ce-proof && rm -rf "$T"
plugins/compound-engineering/skills/ce-proof/SKILL.mdProof - Collaborative Markdown Editor
Proof is a collaborative document editor for humans and agents. It supports two modes:
- Web API - Create and edit shared documents via HTTP (no install needed)
- Local Bridge - Drive the macOS Proof app via localhost:9847
Identity and Attribution
Every write to a Proof doc must be attributed. Two fields carry the agent's identity:
- Machine ID (
on every op,by
header):X-Agent-Id
— stable, lowercase-hyphenated, machine-parseable. Appears in marks, events, and the API response.ai:compound-engineering - Display name (
onname
):POST /presence
— human-readable, shown in Proof's presence chips and comment-author badges.Compound Engineering
Set the display name once per doc session by posting to presence with the
X-Agent-Id header; Proof binds the name to that agent ID for the session. These values are the defaults for any caller of this skill; callers running HITL review (references/hitl-review.md) may pass a different identity pair if a distinct sub-agent should own the doc. Do not use ai:compound or other ad-hoc variants — identity stays uniform unless a caller explicitly overrides it.
Human-in-the-Loop Review Mode
Human-in-the-loop iteration over an existing local markdown file: upload to Proof, let the user annotate in Proof's web UI, ingest feedback as in-thread replies and tracked edits, and sync the final doc back to disk. Two entry points, identical mechanics — load
references/hitl-review.md for the full loop spec (invocation contract, mark classification, idempotent ingest passes, exception-based terminal reporting, end-sync atomic write) in either case:
- Direct user request — a bare user phrase naming a local markdown file and asking to iterate collaboratively via Proof: "share this to proof so we can iterate", "iterate with proof on this doc", "HITL this file with me", "let's get feedback on this in proof", "open this in proof editor so I can review". The file is whichever markdown the user just created, edited, or referenced; if ambiguous, ask which file. This is a first-class entry point — do not require an upstream caller.
- Upstream skill handoff —
,ce-brainstorm
, orce-ideate
finishes a draft and hands it off for human review before the next phase, passing the file path and title explicitly.ce-plan
Web API (Primary for Sharing)
Create a Shared Document
No authentication required. Returns a shareable URL with access token.
curl -X POST https://www.proofeditor.ai/share/markdown \ -H "Content-Type: application/json" \ -d '{"title":"My Doc","markdown":"# Hello\n\nContent here."}'
Response format:
{ "slug": "abc123", "tokenUrl": "https://www.proofeditor.ai/d/abc123?token=xxx", "accessToken": "xxx", "ownerSecret": "yyy", "_links": { "state": "https://www.proofeditor.ai/api/agent/abc123/state", "ops": "https://www.proofeditor.ai/api/agent/abc123/ops" } }
Use the
tokenUrl as the shareable link. The _links give you the exact API paths.
Read a Shared Document
curl -s "https://www.proofeditor.ai/api/agent/{slug}/state" \ -H "x-share-token: <token>"
Edit a Shared Document
All operations go to
POST https://www.proofeditor.ai/api/agent/{slug}/ops
Note: Use the
/api/agent/{slug}/ops path (from _links in create response), NOT /api/documents/{slug}/ops.
Authentication for protected docs:
- Header:
orx-share-token: <token>Authorization: Bearer <token> - Token comes from the URL parameter:
or the?token=xxx
from create responseaccessToken - Header:
(required for presence; include on ops for consistent attribution)X-Agent-Id: ai:compound-engineering
Wire-format reminder.
/api/agent/{slug}/ops uses a top-level type field; /api/agent/{slug}/edit/v2 uses an operations array where each entry has op. Do not mix — sending op to /ops returns 422.
Every mutation requires a
. Read it from baseToken
/state.mutationBase.token (or /snapshot.mutationBase.token) immediately before each write, and include it in the request body. On BASE_TOKEN_REQUIRED or STALE_BASE, re-read and retry once. See the baseToken recipe in references/hitl-review.md.
header is recommended on every mutation for safe automation retries; required when Idempotency-Key
/state.contract.idempotencyRequired is true.
Comment on text:
{"type": "comment.add", "quote": "text to comment on", "by": "ai:compound-engineering", "text": "Your comment here", "baseToken": "<token>"}
Reply to a comment:
{"type": "comment.reply", "markId": "<id>", "by": "ai:compound-engineering", "text": "Reply text", "baseToken": "<token>"}
Resolve / unresolve a comment:
{"type": "comment.resolve", "markId": "<id>", "by": "ai:compound-engineering", "baseToken": "<token>"} {"type": "comment.unresolve", "markId": "<id>", "by": "ai:compound-engineering", "baseToken": "<token>"}
Suggest a replacement (pending — user must accept/reject):
{"type": "suggestion.add", "kind": "replace", "quote": "original text", "by": "ai:compound-engineering", "content": "replacement text", "baseToken": "<token>"}
Suggest and immediately apply (tracked but committed — user can reject to revert):
{"type": "suggestion.add", "kind": "replace", "quote": "original text", "by": "ai:compound-engineering", "content": "replacement text", "status": "accepted", "baseToken": "<token>"}
status: "accepted" creates the suggestion mark and commits the change in one call. The mark persists as an audit trail with per-edit attribution and a reject-to-revert affordance. Works with kind: "insert" | "delete" | "replace".
Accept or reject an existing suggestion:
{"type": "suggestion.accept", "markId": "<id>", "by": "ai:compound-engineering", "baseToken": "<token>"} {"type": "suggestion.reject", "markId": "<id>", "by": "ai:compound-engineering", "baseToken": "<token>"}
suggestion.resolve is not supported — use accept or reject instead.
Bulk rewrite (whole-doc replacement):
{"type": "rewrite.apply", "content": "full new markdown", "by": "ai:compound-engineering", "baseToken": "<token>"}
Block-level edits via
(separate endpoint, separate shape):/edit/v2
curl -X POST "https://www.proofeditor.ai/api/agent/{slug}/edit/v2" \ -H "Content-Type: application/json" \ -H "x-share-token: <token>" \ -H "X-Agent-Id: ai:compound-engineering" \ -H "Idempotency-Key: <uuid>" \ -d '{ "by": "ai:compound-engineering", "baseToken": "mt1:<token>", "operations": [ {"op": "replace_block", "ref": "b3", "block": {"markdown": "Updated paragraph."}}, {"op": "insert_after", "ref": "b3", "block": {"markdown": "## New section"}} ] }'
Supported
op kinds inside operations: replace_block, insert_before, insert_after, delete_block, replace_range (uses fromRef + toRef), find_replace_in_block (takes occurrence: "first" | "all"). Read /snapshot to get stable block ref IDs and the mutationBase.token.
Editing while a client is connected is fine.
/edit/v2, suggestion.add (including status: "accepted"), and all comment ops work during active collab. Only rewrite.apply is blocked by LIVE_CLIENTS_PRESENT — it would clobber in-flight Yjs edits.
When the loop breaks. If a mutation keeps failing after a fresh read and one retry, or state across reads looks inconsistent, call
POST https://www.proofeditor.ai/api/bridge/report_bug with the failing request ID, slug, and raw response. The server enriches and files an issue.
Known Limitations (Web API)
- Bridge-style endpoints (
) require client version headers (/d/{slug}/bridge/*
,x-proof-client-version
,x-proof-client-build
) and return 426 CLIENT_UPGRADE_REQUIRED without them. Usex-proof-client-protocol
instead./api/agent/{slug}/ops
Local Bridge (macOS App)
Requires Proof.app running. Bridge at
http://localhost:9847.
Required headers:
(identity for presence)X-Agent-Id: claudeContent-Type: application/json
(when multiple docs open)X-Window-Id: <uuid>
Key Endpoints
| Method | Endpoint | Purpose |
|---|---|---|
| GET | | List open documents |
| GET | | Read markdown, cursor, word count |
| GET | | List all suggestions and comments |
| POST | | |
| POST | | |
| POST | | |
| POST | | |
| POST | | |
| POST | | |
| POST | | |
| POST | | |
| POST | | |
| POST | | |
| GET | | Poll for user actions |
Presence Statuses
thinking, reading, idle, acting, waiting, completed
Workflow: Review a Shared Document
When given a Proof URL like
https://www.proofeditor.ai/d/abc123?token=xxx:
- Extract the slug (
) and token from the URLabc123 - Read the document state via the API
- Add comments or suggest edits using the ops endpoint
- The author sees changes in real-time
# Read curl -s "https://www.proofeditor.ai/api/agent/abc123/state" \ -H "x-share-token: xxx" # Get baseToken for the next mutation BASE=$(curl -s "https://www.proofeditor.ai/api/agent/abc123/state" \ -H "x-share-token: xxx" | jq -r '.mutationBase.token') # Comment curl -X POST "https://www.proofeditor.ai/api/agent/abc123/ops" \ -H "Content-Type: application/json" \ -H "x-share-token: xxx" \ -H "X-Agent-Id: ai:compound-engineering" \ -d "$(jq -n --arg base "$BASE" '{type:"comment.add",quote:"text",by:"ai:compound-engineering",text:"comment",baseToken:$base}')" # Suggest edit (tracked, pending) curl -X POST "https://www.proofeditor.ai/api/agent/abc123/ops" \ -H "Content-Type: application/json" \ -H "x-share-token: xxx" \ -H "X-Agent-Id: ai:compound-engineering" \ -d "$(jq -n --arg base "$BASE" '{type:"suggestion.add",kind:"replace",quote:"old",by:"ai:compound-engineering",content:"new",baseToken:$base}')" # Suggest and immediately apply (tracked, committed) curl -X POST "https://www.proofeditor.ai/api/agent/abc123/ops" \ -H "Content-Type: application/json" \ -H "x-share-token: xxx" \ -H "X-Agent-Id: ai:compound-engineering" \ -d "$(jq -n --arg base "$BASE" '{type:"suggestion.add",kind:"replace",quote:"old",by:"ai:compound-engineering",content:"new",status:"accepted",baseToken:$base}')"
Workflow: Create and Share a New Document
# 1. Create RESPONSE=$(curl -s -X POST https://www.proofeditor.ai/share/markdown \ -H "Content-Type: application/json" \ -d '{"title":"My Doc","markdown":"# Title\n\nContent here."}') # 2. Extract URL and token URL=$(echo "$RESPONSE" | jq -r '.tokenUrl') SLUG=$(echo "$RESPONSE" | jq -r '.slug') TOKEN=$(echo "$RESPONSE" | jq -r '.accessToken') # 3. Bind display name via presence curl -s -X POST "https://www.proofeditor.ai/api/agent/$SLUG/presence" \ -H "Content-Type: application/json" \ -H "x-share-token: $TOKEN" \ -H "X-Agent-Id: ai:compound-engineering" \ -d '{"name":"Compound Engineering","status":"reading","summary":"Uploaded doc"}' # 4. Share the URL echo "$URL" # 5. Make edits using the ops endpoint (baseToken required) BASE=$(curl -s "https://www.proofeditor.ai/api/agent/$SLUG/state" \ -H "x-share-token: $TOKEN" | jq -r '.mutationBase.token') curl -X POST "https://www.proofeditor.ai/api/agent/$SLUG/ops" \ -H "Content-Type: application/json" \ -H "x-share-token: $TOKEN" \ -H "X-Agent-Id: ai:compound-engineering" \ -d "$(jq -n --arg base "$BASE" '{type:"comment.add",quote:"Content here",by:"ai:compound-engineering",text:"Added a note",baseToken:$base}')"
Workflow: Pull a Proof Doc to Local
Sync the current Proof doc state to a local markdown file. Used by:
- HITL review end-sync (
Phase 5) when the doc originated from a local filereferences/hitl-review.md - Ad-hoc snapshots of a Proof doc to disk (before closing the tab, archiving, handing off)
- Refreshing a local working copy against the live Proof version
SLUG=<slug> TOKEN=<accessToken> LOCAL=<absolute-path> # One read to a temp file — avoids passing markdown through $(...), which would strip trailing newlines. STATE_TMP=$(mktemp) curl -s "https://www.proofeditor.ai/api/agent/$SLUG/state" \ -H "x-share-token: $TOKEN" > "$STATE_TMP" REVISION=$(jq -r '.revision' "$STATE_TMP") # Atomic write: stream .markdown bytes directly to a temp sibling, then rename. TMP="${LOCAL}.proof-sync.$$" jq -jr '.markdown' "$STATE_TMP" > "$TMP" && mv "$TMP" "$LOCAL" rm "$STATE_TMP"
jq -jr (-j no trailing newline, -r raw string) streams the markdown bytes straight to the temp file without going through a shell variable, so trailing newlines survive intact. mv within the same filesystem is atomic — a crashed write leaves the original untouched rather than a half-written file.
Confirm before writing when the pull isn't directly asked for. If a workflow ends up pulling as a side-effect of a different action (e.g., HITL review completion), surface the impending write with a short confirm like "Sync reviewed doc to
<localPath>?" A silent overwrite is surprising — the user may have forgotten the local file exists in that session, or expected Proof to stay canonical until they explicitly asked to pull.
Safety
- Use
content as source of truth before editing/state - During active collab use
(direct block changes) oredit/v2
(tracked changes); reservesuggestion.add
for no-client scenarios since it's blocked byrewrite.apply
when anyone is connectedLIVE_CLIENTS_PRESENT - Don't span table cells in a single replace
- Always include
on every op andby: "ai:compound-engineering"
in headers for consistent attributionX-Agent-Id: ai:compound-engineering - Read a fresh
before every mutation; onbaseToken
, re-read and retry onceSTALE_BASE