rulereceipt 0.1.63 → 0.1.64

package/README.md

@@ -49,6 +49,17 @@ showing you exactly what it will add and asking. `protect --undo` restores the
 file byte-for-byte. It's the only place RuleReceipt writes settings, and only
 with your yes.
 
+To share the result:
+
+```bash
+npx rulereceipt card
+```
+
+Writes a small SVG summary and prints ready-to-post links for X, LinkedIn,
+Bluesky and Reddit, plus copy-text for Slack or a PR. It carries **counts
+only** — no code, paths, or rule text (add rule names to the copy-text with
+`--show-rules`). Nothing is posted for you and nothing is uploaded.
+
 ## Status
 
 Published and live on npm, actively developed.

package/dist/card.d.ts

@@ -0,0 +1,36 @@
+/**
+ * `rulereceipt card` — a shareable image and pre-filled share links, built from
+ * history-mode counts. This is the "share it" step: someone runs RuleReceipt,
+ * sees their agent's mistakes, fixes them with `protect`, and posts the card.
+ *
+ * Privacy is the whole point of it being shareable: by default the card and the
+ * share text carry ONLY counts — never code, file paths, or rule text. A rule's
+ * name appears only when the user passes `--show-rules`, and even then only in
+ * the copy-text, never the image. Nothing is posted automatically and nothing
+ * is uploaded; the links open a compose window the user chooses to send.
+ */
+export interface CardData {
+    broken: number;
+    followed: number;
+    judgment: number;
+    sessions: number;
+    days: number;
+    /** "Claude" when the sessions are all Claude Code, else "the agent". */
+    who: string;
+    /** Titles of the broken rules — only used with --show-rules. */
+    brokenTitles?: string[];
+}
+/** The share caption. Counts only, unless showRules adds the broken rule names. */
+export declare function shareText(d: CardData, showRules?: boolean): string;
+export interface ShareLinks {
+    x: string;
+    linkedin: string;
+    bluesky: string;
+    reddit: string;
+}
+/** Compose-window links for each network. No auth, no posting — the user sends it. */
+export declare function shareLinks(text: string): ShareLinks;
+/** A self-contained SVG card. Counts only — never rule text, paths or code. */
+export declare function cardSvg(d: CardData): string;
+/** The terminal block: where the image went, the share links, and the copy-text. */
+export declare function renderCardShare(d: CardData, outPath: string, showRules?: boolean): string;

package/dist/card.js

@@ -0,0 +1,76 @@
+/**
+ * `rulereceipt card` — a shareable image and pre-filled share links, built from
+ * history-mode counts. This is the "share it" step: someone runs RuleReceipt,
+ * sees their agent's mistakes, fixes them with `protect`, and posts the card.
+ *
+ * Privacy is the whole point of it being shareable: by default the card and the
+ * share text carry ONLY counts — never code, file paths, or rule text. A rule's
+ * name appears only when the user passes `--show-rules`, and even then only in
+ * the copy-text, never the image. Nothing is posted automatically and nothing
+ * is uploaded; the links open a compose window the user chooses to send.
+ */
+const SITE = "rulereceipt.dev";
+/** The share caption. Counts only, unless showRules adds the broken rule names. */
+export function shareText(d, showRules = false) {
+    const base = d.broken > 0
+        ? `${d.who} broke my written rules ${d.broken} time${d.broken === 1 ? "" : "s"} in ${d.days} days (${d.sessions} session${d.sessions === 1 ? "" : "s"}) — now it can't.`
+        : `RuleReceipt checked ${d.sessions} of my agent session${d.sessions === 1 ? "" : "s"} over ${d.days} days against my written rules: ${d.broken} broken.`;
+    const tail = `Checked with RuleReceipt — runs locally, nothing uploaded. ${SITE}`;
+    if (showRules && d.broken > 0 && d.brokenTitles && d.brokenTitles.length > 0) {
+        const list = d.brokenTitles.slice(0, 3).map((t) => `“${t.replace(/\s+/g, " ").trim().slice(0, 50)}”`).join(", ");
+        return `${base}\nBroke: ${list}.\n${tail}`;
+    }
+    return `${base}\n${tail}`;
+}
+/** Compose-window links for each network. No auth, no posting — the user sends it. */
+export function shareLinks(text) {
+    const t = encodeURIComponent(text);
+    const url = encodeURIComponent(`https://${SITE}`);
+    const title = encodeURIComponent(text.split("\n")[0]);
+    return {
+        x: `https://twitter.com/intent/tweet?text=${t}`,
+        // LinkedIn's offsite share only takes a URL; the caption is added by the user.
+        linkedin: `https://www.linkedin.com/sharing/share-offsite/?url=${url}`,
+        bluesky: `https://bsky.app/intent/compose?text=${t}`,
+        reddit: `https://www.reddit.com/submit?title=${title}&url=${url}`,
+    };
+}
+function esc(s) {
+    return s.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+/** A self-contained SVG card. Counts only — never rule text, paths or code. */
+export function cardSvg(d) {
+    const headline = d.broken > 0 ? `${d.who} broke your rules ${d.broken}×` : `0 rules broken`;
+    const sub = `${d.sessions} session${d.sessions === 1 ? "" : "s"} · last ${d.days} days`;
+    const stats = `${d.followed} followed · ${d.judgment} need judgment`;
+    return `<svg xmlns="http://www.w3.org/2000/svg" width="800" height="418" viewBox="0 0 800 418" role="img" aria-label="RuleReceipt summary">
+  <rect width="800" height="418" fill="#0b0d10"/>
+  <rect x="0" y="0" width="800" height="6" fill="${d.broken > 0 ? "#e5534b" : "#3fb950"}"/>
+  <text x="56" y="86" fill="#8b949e" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="20">RuleReceipt</text>
+  <text x="56" y="196" fill="#e6edf3" font-family="-apple-system, Segoe UI, Roboto, sans-serif" font-size="52" font-weight="700">${esc(headline)}</text>
+  <text x="56" y="248" fill="#8b949e" font-family="-apple-system, Segoe UI, Roboto, sans-serif" font-size="24">${esc(sub)}</text>
+  <text x="56" y="300" fill="#8b949e" font-family="-apple-system, Segoe UI, Roboto, sans-serif" font-size="22">${esc(stats)}</text>
+  <text x="56" y="372" fill="#6e7681" font-family="ui-monospace, SFMono-Regular, Menlo, monospace" font-size="18">proof from real sessions · local · nothing uploaded · ${SITE}</text>
+</svg>`;
+}
+/** The terminal block: where the image went, the share links, and the copy-text. */
+export function renderCardShare(d, outPath, showRules = false) {
+    const text = shareText(d, showRules);
+    const links = shareLinks(text);
+    const out = [];
+    out.push(`Saved a shareable card to ${outPath} (counts only — no code, paths or rule text).`);
+    out.push("");
+    out.push("Share it (opens a compose window — nothing is posted for you):");
+    out.push(`  X / Twitter  ${links.x}`);
+    out.push(`  LinkedIn     ${links.linkedin}`);
+    out.push(`  Bluesky      ${links.bluesky}`);
+    out.push(`  Reddit       ${links.reddit}`);
+    out.push("");
+    out.push("Copy text (for Slack / Discord / a PR):");
+    out.push(text.split("\n").map((l) => `  ${l}`).join("\n"));
+    if (!showRules && d.broken > 0) {
+        out.push("");
+        out.push("(Rule names are left out. Add them with --show-rules if you want them in the copy-text.)");
+    }
+    return out.join("\n");
+}

package/dist/cli.js

@@ -18,6 +18,7 @@ import { buildWrongReport, findTarget } from "./wrong.js";
 import { detectSelfEditedRuleFiles } from "./checks/selfEditedRules.js";
 import { scanHistory, renderHistory } from "./historyReport.js";
 import { planProtect, applyProtect, undoProtect } from "./protect.js";
+import { cardSvg, renderCardShare } from "./card.js";
 import { createInterface } from "node:readline";
 import { loadOverrides, saveOverride, clearOverride, staleOverrides, ruleFingerprint, OVERRIDES_PATH } from "./overrides.js";
 import { runHook } from "./hook.js";
@@ -1087,6 +1088,40 @@ program
     console.log("The hooks call `rulereceipt` on your PATH (install once with `npm i -g rulereceipt`); they fail open if it's missing.");
     console.log("Undo:  rulereceipt protect --undo");
 });
+program
+    .command("card")
+    .description("Make a shareable image and pre-filled share links from your last 30 days of sessions — counts only, no code, paths or rule text (add rule names to the copy-text with --show-rules). Saves an SVG locally and prints X/LinkedIn/Bluesky/Reddit compose links. Nothing is posted and nothing is uploaded.")
+    .option("--out <path>", "where to write the SVG card", "rulereceipt-card.svg")
+    .option("--show-rules", "include the broken rule names in the copy-text (never in the image)")
+    .option("--days <n>", "how many days back to summarize", "30")
+    .action(async (opts) => {
+    const cwd = process.cwd();
+    const rules = loadRules(cwd);
+    if (rules.length === 0) {
+        console.log("No rules file found for this project, so there's nothing to summarize. Add a CLAUDE.md or AGENTS.md first.");
+        process.exitCode = 1;
+        return;
+    }
+    const days = Number.parseInt(opts.days ?? "30", 10);
+    const s = await scanHistory(cwd, rules, Number.isFinite(days) && days > 0 ? days : 30);
+    if (s.sessionsScanned === 0) {
+        console.log("No sessions found for this project in the window, so there's nothing to put on a card yet. Run your agent here, then try again.");
+        process.exitCode = 1;
+        return;
+    }
+    const data = {
+        broken: s.totalBrokenCount,
+        followed: s.followedRules,
+        judgment: s.judgmentRules,
+        sessions: s.sessionsScanned,
+        days: s.days,
+        who: s.tools.length === 1 && s.tools[0] === "claude-code" ? "Claude" : "the agent",
+        brokenTitles: s.breaks.map((b) => b.ruleTitle),
+    };
+    const outPath = resolve(cwd, opts.out ?? "rulereceipt-card.svg");
+    writeFileSync(outPath, cardSvg(data));
+    console.log(renderCardShare(data, outPath, Boolean(opts.showRules)));
+});
 program
     .command("history")
     .description("Check EVERY session for this project in the last 30 days (this is what runs when you type `rulereceipt` with no arguments). Leads with the rules broken most, each with a count, the last date and one quoted line. Counts only proven breaks; judgment rules stay separate. No session to pick, no API key, nothing uploaded.")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rulereceipt",
-  "version": "0.1.63",
+  "version": "0.1.64",
   "description": "Checks whether your AI coding agent followed your rules, with evidence. Works with Claude Code (Codex in testing); reads CLAUDE.md, AGENTS.md, Cursor, Copilot and Windsurf rules.",
   "repository": {
     "type": "git",