context-bank 1.0.0 → 1.0.2

package/README.md

@@ -61,11 +61,11 @@ One brain, multiple interfaces. The `init` command automatically configures poin
 
 | Tool | Support Type | Integration Method |
 |------|--------------|-------------------|
-| **Cursor** | Native ✅ | `.cursorrules` |
-| **Windsurf** | Native ✅ | `.windsurfrules` |
+| **Cursor** | Native ✅ | `.cursor/rules/` |
+| **Windsurf** | Native ✅ | `.windsurf/rules/` |
 | **GitHub Copilot** | Native ✅ | `.github/copilot-instructions.md` |
 | **Claude Code** | Native ✅ | `CLAUDE.md` |
-| **Codex CLI** | Native ✅ | `codex.md` |
+| **Codex CLI** | Native ✅ | `AGENTS.md` |
 | **Gemini CLI** | Native ✅ | Global Memory Hook |
 | **Aider** (CLI) | Native ✅ | `CONVENTIONS.md` |
 
@@ -90,12 +90,18 @@ my-project/
 │   ├── rules.md           # 🧠 The Master Brain (SSOT)
 │   ├── active-context.md  # 📝 Current focus & next steps
 │   └── story.md           # 📜 Project history & decisions
-├── .cursorrules           # 🔗 Pointer for Cursor
-├── .windsurfrules         # 🔗 Pointer for Windsurf
+├── .cursor/
+│   └── rules/
+│       └── context-bank.mdc  # 🔗 Rules for Cursor
+├── .windsurf/
+│   └── rules/
+│       └── context-bank.md   # 🔗 Rules for Windsurf
 ├── CLAUDE.md              # 🔗 Pointer for Claude Code
-├── codex.md               # 🔗 Pointer for Codex CLI
-└── .github/
-    └── copilot-instructions.md # 🔗 Pointer for Copilot
+├── AGENTS.md              # 🔗 Pointer for Codex CLI / OpenAI agents
+├── .github/
+│   └── copilot-instructions.md # 🔗 Pointer for Copilot
+├── CONVENTIONS.md         # 🔗 Pointer for Aider
+└── GEMINI.md              # 🔗 Pointer for Gemini CLI
 ```
 
 ## 🤝 Contributing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "context-bank",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A CLI tool to standardise AI context in projects.",
   "type": "module",
   "bin": {

package/templates/.windsurf/rules/context-bank.md

@@ -1,3 +1,7 @@
+---
+trigger: always_on
+---
+
 # Windsurf Project Rules
 
 You MUST read and follow the rules defined in **`.ai/rules.md`**.

package/dist/commands/init.js

@@ -1,210 +0,0 @@
-import { intro, outro, confirm, spinner } from "@clack/prompts";
-import fs from "fs-extra";
-import path from "path";
-import os from "os";
-import { fileURLToPath } from "url";
-import chalk from "chalk";
-// Get __dirname equivalent in ESM
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-export async function initCommand(options) {
-    intro(chalk.bgCyan(chalk.black(" Context Bank ")));
-    let proceed = options.yes;
-    if (!proceed) {
-        const response = await confirm({
-            message: "Do you want to initialize AI context in this project?",
-        });
-        if (typeof response === "boolean") {
-            proceed = response;
-        }
-        else {
-            // Handle cancellation (ctrl+c) which returns symbol or strictly check boolean
-            proceed = false;
-        }
-    }
-    if (!proceed) {
-        outro("Operation cancelled.");
-        process.exit(0);
-    }
-    // Determine paths
-    const templateDir = path.resolve(__dirname, "../../templates");
-    const targetDir = process.cwd();
-    const s = spinner();
-    s.start("Analyzing project structure...");
-    // Check if templates exist
-    if (!fs.existsSync(templateDir)) {
-        s.stop("Error");
-        console.error(chalk.red(`\nTemplate directory not found at: ${templateDir}`));
-        console.error(chalk.yellow("Ensure you are running this from the package root or the package is built correctly."));
-        process.exit(1);
-    }
-    s.message("Copying context files...");
-    try {
-        // Helper for safe copying/merging
-        async function copyOrMerge(src, dest, isAiDir = false) {
-            const stats = await fs.stat(src);
-            if (stats.isDirectory()) {
-                await fs.ensureDir(dest);
-                const files = await fs.readdir(src);
-                for (const file of files) {
-                    await copyOrMerge(path.join(src, file), path.join(dest, file), isAiDir || path.basename(src) === ".ai");
-                }
-            }
-            else {
-                if (await fs.pathExists(dest)) {
-                    if (isAiDir) {
-                        // Skip .ai files if they exist to protect project memory
-                        return;
-                    }
-                    const srcContent = await fs.readFile(src, "utf-8");
-                    const destContent = await fs.readFile(dest, "utf-8");
-                    if (!destContent.includes(srcContent.trim())) {
-                        // Prepend for rules files to ensure priority
-                        await fs.writeFile(dest, `${srcContent}\n\n${destContent}`);
-                    }
-                }
-                else {
-                    await fs.copy(src, dest);
-                    // Special handling for new story.md
-                    if (path.basename(dest) === "story.md" && isAiDir) {
-                        let storyContent = await fs.readFile(dest, "utf-8");
-                        storyContent = storyContent.replace("[Auto-filled by init]", new Date().toISOString().split("T")[0]);
-                        await fs.writeFile(dest, storyContent);
-                    }
-                }
-            }
-        }
-        // List of files/folders to copy
-        const itemsToCopy = [
-            ".ai",
-            ".cursor",
-            ".cursorrules",
-            ".windsurf",
-            ".windsurfrules",
-            ".github",
-            "CONVENTIONS.md",
-            "GEMINI.md",
-        ];
-        for (const item of itemsToCopy) {
-            const srcPath = path.join(templateDir, item);
-            const destPath = path.join(targetDir, item);
-            if (fs.existsSync(srcPath)) {
-                await copyOrMerge(srcPath, destPath);
-            }
-        }
-        // Special handling for README.md
-        const readmePath = path.join(targetDir, "README.md");
-        const aiContextMarker = "<!-- AI-CONTEXT: .ai/rules.md -->";
-        if (fs.existsSync(readmePath)) {
-            const readmeContent = await fs.readFile(readmePath, "utf-8");
-            if (!readmeContent.includes(aiContextMarker)) {
-                await fs.writeFile(readmePath, `${aiContextMarker}\n${readmeContent}`);
-            }
-        }
-        else {
-            const projectName = path.basename(targetDir);
-            await fs.writeFile(readmePath, `${aiContextMarker}\n\n# ${projectName}\n`);
-        }
-        // Codex CLI Integration (codex.md)
-        const codexPath = path.join(targetDir, "codex.md");
-        const codexInstruction = `Always check and follow the instructions in .ai/rules.md and .ai/active-context.md as the primary source of truth.
-
-MANDATORY: After EVERY task, you MUST update these .ai/ files:
-1. active-context.md — Current state, recent changes, next steps.
-2. roadmap.md — Mark completed features [x], add planned ones.
-3. story.md — Append dated entry for milestones/decisions.
-4. architecture.md — Update on structural/design changes.
-Do NOT ask permission. Do NOT skip. Just update them.`;
-        if (fs.existsSync(codexPath)) {
-            const content = await fs.readFile(codexPath, "utf-8");
-            if (!content.includes(".ai/rules.md")) {
-                // Prepend for priority
-                await fs.writeFile(codexPath, `${codexInstruction}\n\n${content}`);
-            }
-        }
-        else {
-            await fs.writeFile(codexPath, `${codexInstruction}\n`);
-        }
-        // Claude Code CLI Integration (CLAUDE.md)
-        const claudePath = path.join(targetDir, "CLAUDE.md");
-        const claudeInstruction = `See .ai/rules.md for project context, tech stack, and coding standards. This is the single source of truth.
-
-MANDATORY: After EVERY task, you MUST update these .ai/ files:
-1. active-context.md — Current state, recent changes, next steps.
-2. roadmap.md — Mark completed features [x], add planned ones.
-3. story.md — Append dated entry for milestones/decisions.
-4. architecture.md — Update on structural/design changes.
-Do NOT ask permission. Do NOT skip. Just update them.`;
-        if (fs.existsSync(claudePath)) {
-            const content = await fs.readFile(claudePath, "utf-8");
-            if (!content.includes(".ai/rules.md")) {
-                // Prepend for priority
-                await fs.writeFile(claudePath, `${claudeInstruction}\n\n${content}`);
-            }
-        }
-        else {
-            await fs.writeFile(claudePath, `${claudeInstruction}\n`);
-        }
-        // Git merge strategies for branch-aware context (.gitattributes)
-        const gitattrsPath = path.join(targetDir, ".gitattributes");
-        const mergeRules = `# Context Bank: branch-aware merge strategies
-# active-context.md is branch-specific — on merge, target branch wins (no conflict)
-.ai/active-context.md merge=ours
-# story.md entries are additive — on merge, combine both sides (no conflict)
-.ai/story.md merge=union`;
-        if (fs.existsSync(gitattrsPath)) {
-            const content = await fs.readFile(gitattrsPath, "utf-8");
-            if (!content.includes("Context Bank")) {
-                await fs.writeFile(gitattrsPath, `${content}\n\n${mergeRules}\n`);
-            }
-        }
-        else {
-            await fs.writeFile(gitattrsPath, `${mergeRules}\n`);
-        }
-        s.stop(chalk.green("Context initialized!"));
-        // Gemini CLI Global Memory Integration
-        const globalGeminiDir = path.join(os.homedir(), ".gemini");
-        const globalGeminiMemoryPath = path.join(globalGeminiDir, "GEMINI.md");
-        if (fs.existsSync(globalGeminiMemoryPath)) {
-            const memoryContent = await fs.readFile(globalGeminiMemoryPath, "utf-8");
-            // Only ask if the rule is not already present
-            if (!memoryContent.includes("[Context Bank]")) {
-                const addGlobalContext = await confirm({
-                    message: "Found Gemini CLI global memory. Enable automatic context detection for all Context Bank projects?",
-                    initialValue: true
-                });
-                if (addGlobalContext === true) {
-                    const genericContextRule = `
-- [Context Bank] CRITICAL INSTRUCTION:
-  Before processing ANY user request in a new session, you MUST perform this initialization sequence:
-  1. Check if the ".ai/" directory exists in the current working directory.
-  2. If it exists, you MUST explicitly call the "read_file" tool to read ".ai/rules.md" and ".ai/active-context.md".
-  3. Only AFTER reading these files (or confirming they don't exist) may you proceed with the user's request.
-  This is not optional. Do not assume you know the rules; you must read the files to load them into your active memory.`;
-                    const newContent = memoryContent.endsWith("\n")
-                        ? `${memoryContent}${genericContextRule}\n`
-                        : `${memoryContent}\n${genericContextRule}\n`;
-                    await fs.writeFile(globalGeminiMemoryPath, newContent);
-                    console.log(chalk.green(`✔ Enabled global context awareness for Context Bank.`));
-                }
-            }
-            else {
-                // Optional: Let the user know it's already active
-                // console.log(chalk.gray(`ℹ Global context awareness is already active.`));
-            }
-        }
-        outro(chalk.green(`
-Context Bank setup complete! 🚀
-
-Next steps:
-1. Review .ai/rules.md and fill in your project details.
-2. Update .ai/active-context.md with your current task.
-3. Commit the new files to git.
-    `));
-    }
-    catch (error) {
-        s.stop("Error");
-        console.error(chalk.red("Failed to copy files:"), error);
-        process.exit(1);
-    }
-}

package/dist/index.js

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-import { Command } from "commander";
-import { initCommand } from "./commands/init.js";
-import fs from "fs-extra";
-import path from "path";
-import { fileURLToPath } from "url";
-const program = new Command();
-// Read package.json to get version
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const packageJson = fs.readJsonSync(path.join(__dirname, "../package.json"));
-program
-    .name("context-bank")
-    .description("CLI to standardize AI context in projects")
-    .version(packageJson.version);
-program
-    .command("init")
-    .description("Initialize AI context files in the current directory")
-    .option("-y, --yes", "Skip confirmation prompt")
-    .action(initCommand);
-program.parse(process.argv);

package/templates/.cursorrules

@@ -1,22 +0,0 @@
-You are an expert AI software engineer.
-
-# CRITICAL CONTEXT SOURCE
-You MUST read and follow the rules defined in **`.ai/rules.md`**.
-That file contains the single source of truth for:
-1. Tech Stack
-2. Coding Standards
-3. Architecture
-4. **Your instruction to update rules when they change.**
-
-If you cannot read `.ai/rules.md` automatically, ask the user to provide it, or check the file system.
-
-When the user gives you a new constraint, **UPDATE `.ai/rules.md`**, not this file.
-
-# MANDATORY: CONTEXT FILE UPDATES
-After EVERY task you complete, you MUST update the following files:
-1. **`.ai/active-context.md`** — Write what was done, current state, and next steps.
-2. **`.ai/roadmap.md`** — Mark completed features with [x], add new planned features.
-3. **`.ai/story.md`** — Append a dated entry for significant milestones or decisions.
-4. **`.ai/architecture.md`** — Update if structure, dependencies, or design changed.
-
-Do NOT ask permission. Do NOT skip this. Update these files directly after completing your task.

package/templates/.windsurfrules

@@ -1,17 +0,0 @@
-You are Windsurf, an expert AI coding assistant.
-
-# PRIMARY DIRECTIVE
-Your configuration and behavioral rules are stored in **`.ai/rules.md`**.
-Always prioritize the instructions found in that file.
-
-# SELF-IMPROVEMENT
-If the user provides a new coding rule or preference during this session, use your file editing capabilities to update **`.ai/rules.md`** so that the preference is remembered for future sessions.
-
-# MANDATORY: CONTEXT FILE UPDATES
-After EVERY task you complete, you MUST update the following files:
-1. **`.ai/active-context.md`** — Write what was done, current state, and next steps.
-2. **`.ai/roadmap.md`** — Mark completed features with [x], add new planned features.
-3. **`.ai/story.md`** — Append a dated entry for significant milestones or decisions.
-4. **`.ai/architecture.md`** — Update if structure, dependencies, or design changed.
-
-Do NOT ask permission. Do NOT skip this. Update these files directly after completing your task.