@esneiderbravo/speclaw 0.2.0 → 0.2.1

package/README.md

@@ -162,6 +162,19 @@ still use Compass and the lawbook engine by calling the CLI from its shell.
   <img src="https://raw.githubusercontent.com/esneiderbravo/speclaw/main/brand/terminal-tree.png" width="800" alt="what speclaw writes into your project">
 </p>
 
+**Committed vs. local.** Your **personalized source** is committed — `LAWS.md`,
+`CLAUDE.md`, `AGENTS.md`, `docs/standards/*`, `docs/compass.md`, and the
+`lawbook/` workspace. speclaw's **regenerable workflow content is local, not
+committed**: only `ai-specs/` (skills, commands, rules, agent packs, and its
+`.speclaw.json` manifest) is gitignored, because `init`/`update` reconstruct it
+from the package — like a dependency. So **after cloning a speclaw project, run
+`speclaw init` (or `speclaw update`)** to regenerate `ai-specs/` locally, which
+the agent IDE symlinks point into. If a project committed `ai-specs/` before
+this behavior existed, `init`/`update` print the exact `git rm -r --cached
+ai-specs` command to stop tracking it (they never touch your git index
+themselves). The agent directories (`.claude/`, `.cursor/`, …) are **left to
+you** — commit your own skills and commands there if you want to.
+
 <br/>
 
 ## <img src="https://raw.githubusercontent.com/esneiderbravo/speclaw/main/brand/diamond.png" height="20" alt="◆" align="absmiddle">&nbsp; Philosophy — why "laws"?
@@ -189,9 +202,10 @@ without a re-init, splitting files by who owns them:
 
 - **Managed files** (speclaw's workflow machinery — the skills, commands, rules,
   and agent packs under `ai-specs/`) are **refreshed** to the new version, so
-  improvements actually reach your project. If you edited one locally, `update`
-  reports the overwrite so you can recover your copy from git; pass `--backup` to
-  also keep a `<file>.bak`. Any `*.bak` is gitignored.
+  improvements actually reach your project. They live locally (gitignored, see
+  *What lands in your project*) and are reconstructed from the package. If you
+  edited one locally, `update` reports the overwrite; pass `--backup` to keep a
+  `<file>.bak` (itself gitignored) before it is refreshed.
 - **Personalized files** (your constitution and standards — `CLAUDE.md`,
   `AGENTS.md`, `LAWS.md`, `docs/standards/*`, `docs/compass.md`,
   `lawbook/config.yaml`) are **never auto-edited**. When a release changes their

package/dist/cli/commands/init.js

@@ -9,6 +9,7 @@ import { loadPacks } from "../../modules/tools/packs.js";
 import { list } from "../lib/args.js";
 import { ui, c, banner, renderProgress, clearProgress } from "../lib/ui.js";
 import { checkForUpdates } from "../lib/update-check.js";
+import { reportTrackedLocalContent } from "../lib/untrack.js";
 const PACK_LABELS = {
     agents: "dev-agents (backend · frontend · product)",
 };
@@ -99,6 +100,9 @@ export async function runInit(flags) {
     ui.step("Configuring agents");
     for (const id of agents)
         ui.ok(`${agentById(id).label} ${c.muted("— symlinks + MCP")}`);
+    // ai-specs/ is gitignored (regenerated by init/update). If a prior setup
+    // already committed it, tell the user how to untrack it.
+    reportTrackedLocalContent(cwd);
     // 2. Compass index with progress
     if (!flags["no-index"]) {
         ui.step("Indexing your code with Compass");
@@ -132,4 +136,6 @@ export async function runInit(flags) {
     ui.info(`Refresh index:  ${ui.code("speclaw index")}`);
     ui.info(`Health check:   ${ui.code("speclaw doctor")}`);
     ui.plain();
+    ui.info(`${c.muted("ai-specs/ is local (gitignored) — teammates run")} ${ui.code("speclaw init")} ${c.muted("after cloning to regenerate it.")}`);
+    ui.plain();
 }

package/dist/cli/commands/update.js

@@ -10,6 +10,7 @@ import { detectConfiguredAgents } from "../../shared/agents.js";
 import { readManifest } from "../../shared/manifest.js";
 import { loadPacks } from "../../modules/tools/packs.js";
 import { detectProjectName } from "./init.js";
+import { reportTrackedLocalContent } from "../lib/untrack.js";
 // The first migration must be tagged at the version that introduces this
 // mechanism (0.1.12): `isNewer` is strict, so an entry tagged at an already-
 // shipped version (e.g. 0.1.11) would never fire for projects already on it.
@@ -196,6 +197,10 @@ function applyProjectMigrations(cwd, backup) {
         console.log(c.cream(prompt));
         ui.plain();
     }
+    // This release makes ai-specs/ local (gitignored). A project that committed
+    // it before now still tracks it — point out how to untrack (speclaw never
+    // touches the git index itself).
+    reportTrackedLocalContent(cwd);
     ui.plain();
     ui.ok(`On ${c.cyan(pkgVersion())}. No re-init needed.`);
 }

package/dist/cli/lib/untrack.js

@@ -0,0 +1,25 @@
+import { ui, c } from "./ui.js";
+import { listTrackedPaths } from "../../shared/git.js";
+/**
+ * If `ai-specs/` is still tracked by git, print the exact `git rm -r --cached`
+ * command to untrack it. `ai-specs/` is regenerable from the package, so
+ * init/update gitignore it — but adding a `.gitignore` entry does not stop git
+ * tracking a directory it already tracks, so this is how an already-installed
+ * project makes that content local. It only prints — it never modifies the git
+ * index — and no-ops silently outside a git repository or when nothing is
+ * tracked. The agents' IDE directories (`.claude/`, …) are deliberately left
+ * alone, so a user's own skills/commands there stay committable.
+ *
+ * @param projectPath - Project root to inspect and address.
+ */
+export function reportTrackedLocalContent(projectPath) {
+    const tracked = listTrackedPaths(projectPath, ["ai-specs"]);
+    if (!tracked.length)
+        return;
+    ui.step("Make ai-specs/ local-only");
+    ui.info("git still tracks ai-specs/ (regenerable). To stop tracking it (it stays on disk):");
+    ui.plain();
+    console.log("  " + c.cream(`git rm -r --cached ${tracked.join(" ")}`));
+    console.log("  " + c.cream('git commit -m "chore: stop tracking speclaw local content"'));
+    ui.plain();
+}

package/dist/modules/foundation/scaffold.js

@@ -104,6 +104,10 @@ export function scaffold(projectPath, profile, packNames, agents = [], opts = {}
         installPack(projectPath, name, vars, report, managedOpts); // managed
     ensureGitignore(projectPath, ".speclaw/", "speclaw local code Compass (never commit)", report);
     ensureGitignore(projectPath, "*.bak", "speclaw managed-file refresh backups", report);
+    // ai-specs/ is regenerable from the package (installWorkflow/installPack copy
+    // it out of the module assets) plus the local .speclaw.json manifest — local,
+    // per-checkout content, reconstructed by init/update, never committed.
+    ensureGitignore(projectPath, "ai-specs/", "speclaw workflow content (regenerated by init/update; never commit)", report);
     for (const id of agents)
         configureAgent(projectPath, id, report); // only the chosen agents
     // Record what was installed so `speclaw update` can re-apply these packs and

package/dist/shared/git.js

@@ -0,0 +1,39 @@
+import { spawnSync } from "node:child_process";
+/**
+ * True when `projectPath` is inside a git working tree.
+ *
+ * Best-effort: shells `git rev-parse --is-inside-work-tree` and treats any
+ * failure (git not installed, not a repository) as "not a repo" rather than
+ * throwing — callers use this only to decide whether to attempt further git
+ * queries.
+ *
+ * @param projectPath - Directory to test.
+ * @returns `true` only when git reports the path is inside a work tree.
+ */
+export function isGitRepo(projectPath) {
+    const res = spawnSync("git", ["-C", projectPath, "rev-parse", "--is-inside-work-tree"], {
+        encoding: "utf8",
+    });
+    return res.status === 0 && res.stdout.trim() === "true";
+}
+/**
+ * Of `candidates` (project-relative paths), the subset git currently tracks.
+ *
+ * Adding a path to `.gitignore` does not stop git tracking a file it already
+ * tracks; this reports which speclaw paths are still tracked so a command can
+ * tell the user how to untrack them. Returns an empty array when `projectPath`
+ * is not a git repository (or git is unavailable).
+ *
+ * @param projectPath - Project root to query.
+ * @param candidates - Project-relative paths (files, directories, or symlinks).
+ * @returns The candidates for which `git ls-files` reports at least one tracked
+ *   entry, in the order given.
+ */
+export function listTrackedPaths(projectPath, candidates) {
+    if (!isGitRepo(projectPath))
+        return [];
+    return candidates.filter((rel) => {
+        const res = spawnSync("git", ["-C", projectPath, "ls-files", "--", rel], { encoding: "utf8" });
+        return res.status === 0 && res.stdout.trim().length > 0;
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esneiderbravo/speclaw",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "publishConfig": {
     "access": "public"
   },