srm-report 1.0.0 → 1.1.0

package/README.md

@@ -1,6 +1,6 @@
 # srm-report
 
-A Claude Code skill that builds a print-ready SRM Institute report (.docx and .pdf) from the template you attach. It fills a copy of the template, so fixed pages stay as issued, and generates the numbered chapters, contents, lists and references.
+A skill for AI coding agents that builds a print-ready SRM Institute report (.docx and .pdf) from the template you attach. It fills a copy of the template, so fixed pages stay as issued, and generates the numbered chapters, contents, lists and references.
 
 ## Install
 
@@ -8,7 +8,17 @@ A Claude Code skill that builds a print-ready SRM Institute report (.docx and .p
 npx srm-report install
 ```
 
-This copies the skill to `~/.claude/skills/srm-report`. Then attach your template in Claude Code and ask for your report.
+This installs for every agent it finds on your machine. Restart the agent, attach your template and ask for your report.
+
+| Agent | Installed to | Command |
+|---|---|---|
+| Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf, OpenCode, Roo Code | `~/.agents/skills/srm-report` | `--agent codex` (or any of these names) |
+| Claude Code | `~/.claude/skills/srm-report` | `--agent claude` |
+| Antigravity | `~/.gemini/config/skills/srm-report` | `--agent antigravity` |
+| Cline | `~/.cline/skills/srm-report` | `--agent cline` |
+| Kiro | `~/.kiro/skills/srm-report` | `--agent kiro` |
+
+Use `--agent all` for every folder. For any other agent, run `npx srm-report install --dir ./srm-report` and tell it to follow `srm-report/SKILL.md`.
 
 To build the report you need Windows with Microsoft Word, and Python with `python-docx`, `PyMuPDF` and `Pillow`:
 
@@ -24,7 +34,7 @@ Everyone who installs this is asked to raise a pull request with what they impro
 npx srm-report contribute     # shows the diff, sends nothing
 ```
 
-This is a strict guideline for AI agents using the skill: they must record improvements as they work and ask you at the end of every report. Nothing is sent until you have seen the changes and agreed. See [CONTRIBUTING.md](CONTRIBUTING.md).
+This is a strict guideline for AI agents using the skill: they must record improvements as they work and ask you at the end of every report. Nothing is sent until you have seen the changes and agreed. This applies to every agent above. See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## What's inside
 

package/SKILL.md

@@ -29,6 +29,8 @@ See `CONTRIBUTING.md`.
 
 ## How this skill works
 
+This skill works with any agent that reads `SKILL.md`. Paths such as `scripts/rptlib.py` are relative to this file's folder, which differs between agents, so resolve them from where you loaded this file. Recipes find the folder themselves; if one can't, set `SRM_REPORT_SKILL`.
+
 The user attaches the template they want. **The template is the spec.** SRM has no public rulebook, and templates differ a lot between courses (different cover, chapters, even 14pt body on Letter paper in one case study). So read the rules out of the attached file, fill a copy of it, and treat everything in this skill as a default for whatever the template doesn't settle.
 
 When two sources disagree, this order decides:
@@ -82,6 +84,8 @@ python -X utf8 scripts/render_pages.py report.pdf pages 1,2,3,4 70 # chosen page
 
 The Word pass fills the TOC and lists with real page numbers, exports the PDF and reports any table crossing a page. Work on a scratch copy, since the user often has the file open. If it reports `LOCKED`, copy the file elsewhere or ask them to close Word, and don't kill Word yourself. It can take a few minutes on a long report. If it stops with a COM error, run it once more; if the error repeats, the .docx is the problem. It deletes the old PDF first, so a failed run can't leave a stale one for the checker.
 
+The Word pass needs Microsoft Word on Windows, in a session that can start it. If you run in a sandbox, in the cloud or on Linux or macOS and can't reach Word, build the .docx, say that the pass hasn't run, and give the user the exact command to run on their machine or ask for the sandbox to be relaxed. Don't substitute another converter and call the result final, because page numbers and table breaks would differ from what gets printed.
+
 Put the template's numbers in `checks.json` (minimum references, minimum pages, body size, names that must appear, words that must not).
 
 **Open the page images every time.** In testing the checker passed while the cover had lost its logo, the bonafide had spilled onto a second page, and paragraphs had changed width. Some of those are checked now, but not all of them can be. Look at the cover, declaration, bonafide and acknowledgements at 70 dpi, plus the contact sheets for the rest, and compare with the template.

package/assets/examples/project_21cse734p.py

@@ -15,7 +15,13 @@ raises KeyError naming the missing line: run inspect_template.py and adjust the
 """
 import json, os, re, sys
 
-SKILL = os.environ.get("SRM_REPORT_SKILL", os.path.expanduser("~/.claude/skills/srm-report"))
+# Agents keep skills in different folders. This file may also have been copied into a project.
+HERE = os.path.dirname(os.path.abspath(__file__))
+PLACES = [os.environ.get("SRM_REPORT_SKILL"), os.path.join(HERE, "..", "..")] + [
+    os.path.expanduser(f"~/{p}/skills/srm-report") for p in (".agents", ".claude", ".gemini/config", ".cline", ".kiro")]
+SKILL = next((p for p in PLACES if p and os.path.exists(os.path.join(p, "scripts", "rptlib.py"))), None)
+if SKILL is None:
+    sys.exit("Can't find the srm-report skill. Set SRM_REPORT_SKILL to its folder.")
 sys.path.insert(0, os.path.join(SKILL, "scripts"))
 from docx.oxml import parse_xml
 from docx.oxml.ns import qn

package/bin/srm-report.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
-// Installs the srm-report skill for Claude Code, and sends a user's improvements back as a pull request.
+// Installs the srm-report skill for AI coding agents, and sends a user's improvements back as a pull request.
 const { execFileSync } = require("child_process");
+const crypto = require("crypto");
 const fs = require("fs");
 const os = require("os");
 const path = require("path");
@@ -9,7 +10,16 @@ const OWNER = "shauryaaojha";
 const REPO = "srm-report";
 const PKG_ROOT = path.join(__dirname, "..");
 const SKILL_PATHS = ["SKILL.md", "references", "scripts", "assets"];
-const DEFAULT_DIR = path.join(os.homedir(), ".claude", "skills", REPO);
+// Global skill folders from each agent's own docs. `home` is what marks the agent as present on this machine.
+const TARGETS = [
+  { id: "agents", dir: [".agents", "skills"], reads: "Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf, OpenCode, Roo Code" },
+  { id: "claude", dir: [".claude", "skills"], reads: "Claude Code", home: ".claude" },
+  { id: "antigravity", dir: [".gemini", "config", "skills"], reads: "Antigravity", home: ".gemini" },
+  { id: "cline", dir: [".cline", "skills"], reads: "Cline", home: ".cline" },
+  { id: "kiro", dir: [".kiro", "skills"], reads: "Kiro", home: ".kiro" },
+];
+const SHARED = ["codex", "cursor", "gemini", "copilot", "windsurf", "opencode", "roo"]; // all read ~/.agents/skills
+const targetDir = (t) => path.join(os.homedir(), ...t.dir, REPO);
 // Reports and templates must never travel. Only text that improves the skill goes in a pull request.
 const BLOCKED_FILE = /\.(docx?|dotx|pdf|pptx?|xlsx?|png|jpe?g|gif|zip|tgz)$/i;
 const SKIP = /(^|[\\/])(__pycache__|\.git)([\\/]|$)|\.pyc$/;
@@ -19,10 +29,19 @@ const PERSONAL = [
   [/(?<![\d.])[6-9]\d{9}(?![\d.])/, "phone number"],
 ];
 
-const HELP = `srm-report: SRM report skill for Claude Code
+const HELP = `srm-report: SRM report skill for AI coding agents
+
+  npx srm-report install
+      Install for every agent found on this machine. ~/.agents/skills is always included.
+
+  npx srm-report install --agent NAMES
+      Install for the named agents only, comma separated, or "all":
+      ${[...SHARED, ...TARGETS.slice(1).map((t) => t.id)].join(", ")}
 
-  npx srm-report install [--dir PATH] [--force]
-      Copy the skill to ${DEFAULT_DIR}. --force replaces an existing copy.
+  npx srm-report install --dir PATH
+      Install to one folder, for any other agent. Then tell it to follow PATH/SKILL.md.
+
+      Add --force to replace an existing copy.
 
   npx srm-report contribute [--dir PATH]
       Dry run. Compare your copy with the version you installed and print the diff. Sends nothing.
@@ -69,18 +88,72 @@ function copySkill(from, to) {
   }
 }
 
-function install(opts) {
-  const dir = path.resolve(opts.dir || DEFAULT_DIR);
-  if (fs.existsSync(path.join(dir, "SKILL.md")) && !opts.force) {
-    die(`${dir} already has this skill, and may hold your own improvements.\nSend those first with "npx srm-report contribute", or pass --force to replace it.`);
+function chooseTargets(opts) {
+  if (opts.dir) return [{ path: path.resolve(opts.dir), reads: "the agent you point at it" }];
+  let picked;
+  if (opts.agent) {
+    const names = opts.agent.toLowerCase().split(",").map((s) => s.trim()).filter(Boolean);
+    picked = names.includes("all") ? TARGETS : TARGETS.filter((t) => names.includes(t.id) || (t.id === "agents" && names.some((n) => SHARED.includes(n))));
+    const known = ["all", ...SHARED, ...TARGETS.map((t) => t.id)];
+    const bad = names.filter((n) => !known.includes(n));
+    if (bad.length || !picked.length) die(`unknown agent "${bad.join(", ") || opts.agent}". Known: ${known.join(", ")}`);
+  } else {
+    picked = TARGETS.filter((t) => !t.home || fs.existsSync(path.join(os.homedir(), t.home)));
   }
-  fs.mkdirSync(dir, { recursive: true });
-  copySkill(PKG_ROOT, dir);
+  return picked.map((t) => ({ path: targetDir(t), reads: t.reads }));
+}
+
+function skillHash(dir) {
+  const h = crypto.createHash("sha256");
+  const files = SKILL_PATHS.flatMap((p) => {
+    const full = path.join(dir, p);
+    if (!fs.existsSync(full)) return [];
+    return fs.statSync(full).isDirectory() ? listFiles(full).map((f) => path.join(p, f)) : [p];
+  }).sort();
+  for (const f of files) h.update(f.replace(/\\/g, "/")).update(fs.readFileSync(path.join(dir, f)));
+  return h.digest("hex");
+}
+
+function install(opts) {
   const { version } = JSON.parse(fs.readFileSync(path.join(PKG_ROOT, "package.json"), "utf8"));
-  fs.writeFileSync(path.join(dir, "VERSION"), version + "\n");
-  console.log(`Installed srm-report ${version} to ${dir}`);
-  console.log("Claude Code picks it up in the next session.");
-  console.log('If you improve it while making a report, send it back: npx srm-report contribute');
+  let done = 0;
+  for (const t of chooseTargets(opts)) {
+    if (fs.existsSync(path.join(t.path, "SKILL.md")) && !opts.force) {
+      console.log(`Skipped ${t.path}: already there, and it may hold your improvements. Send them with "npx srm-report contribute", or pass --force to replace it.`);
+      continue;
+    }
+    for (const p of SKILL_PATHS) fs.rmSync(path.join(t.path, p), { recursive: true, force: true });
+    fs.mkdirSync(t.path, { recursive: true });
+    copySkill(PKG_ROOT, t.path);
+    fs.writeFileSync(path.join(t.path, "VERSION"), version + "\n");
+    fs.writeFileSync(path.join(t.path, "INSTALL_HASH"), skillHash(t.path) + "\n");
+    console.log(`Installed ${version} to ${t.path} (for ${t.reads})`);
+    done++;
+  }
+  if (done) {
+    console.log("Restart your agent so it finds the skill.");
+    console.log("If you improve it while making a report, send it back: npx srm-report contribute");
+  }
+}
+
+// With several copies installed, the one to send is the one that changed since install.
+function findCopy(opts) {
+  if (opts.dir) {
+    const d = path.resolve(opts.dir);
+    if (!fs.existsSync(path.join(d, "SKILL.md"))) die(`no skill found at ${d}`);
+    return d;
+  }
+  const copies = TARGETS.map(targetDir).filter((d) => fs.existsSync(path.join(d, "SKILL.md")));
+  if (!copies.length) die('no installed skill found. Run "npx srm-report install", or pass --dir PATH.');
+  const stored = (d) => {
+    const f = path.join(d, "INSTALL_HASH");
+    return fs.existsSync(f) ? fs.readFileSync(f, "utf8").trim() : null;
+  };
+  const changed = copies.filter((d) => skillHash(d) !== stored(d));
+  if (changed.length > 1 && new Set(changed.map(skillHash)).size > 1) {
+    die(`more than one copy has changed. Pick one with --dir, after merging what you want to keep:\n  ${changed.join("\n  ")}`);
+  }
+  return changed[0] || copies[0];
 }
 
 function listFiles(dir, base = dir, out = []) {
@@ -103,8 +176,8 @@ function scanAdded(diff) {
 }
 
 function contribute(opts) {
-  const dir = path.resolve(opts.dir || DEFAULT_DIR);
-  if (!fs.existsSync(path.join(dir, "SKILL.md"))) die(`no skill found at ${dir}`);
+  const dir = findCopy(opts);
+  console.log(`Using the copy at ${dir}`);
   if (tryRun("gh", ["auth", "status"]) === null) die('the GitHub CLI is missing or signed out. Install gh and run "gh auth login".');
   if (opts.yes && !opts.title) die('--yes needs --title "what improved"');
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "srm-report",
-  "version": "1.0.0",
-  "description": "Claude Code skill that builds a print-ready SRM Institute report (.docx and .pdf) from the template you attach.",
+  "version": "1.1.0",
+  "description": "Skill for AI coding agents (Claude Code, Codex, Cursor, Antigravity and more) that builds a print-ready SRM Institute report (.docx and .pdf) from the template you attach.",
   "bin": {
     "srm-report": "bin/srm-report.js"
   },
@@ -15,8 +15,13 @@
     "CONTRIBUTING.md"
   ],
   "keywords": [
+    "agent-skills",
     "claude-code",
-    "claude-skill",
+    "codex",
+    "cursor",
+    "antigravity",
+    "gemini-cli",
+    "copilot",
     "srm",
     "srmist",
     "report",