@nolrm/contextkit 0.11.0 → 0.12.4

package/README.md

@@ -2,7 +2,7 @@
 
 > Context Engineering for AI Development
 
-Give your AI assistants (Cursor, Claude, Copilot, Codex, Gemini, Aider, Continue, Windsurf) structured context through markdown files. ContextKit creates a knowledge base that ensures AI generates code matching your exact patterns, style, and architecture—no more hallucinated code or mismatched conventions.
+Give your AI assistants (Cursor, Claude, Copilot, Codex, OpenCode, Gemini, Aider, Continue, Windsurf) structured context through markdown files. ContextKit creates a knowledge base that ensures AI generates code matching your exact patterns, style, and architecture—no more hallucinated code or mismatched conventions.
 
 ContextKit is a CLI tool that provides **context-engineering** capabilities by creating `.contextkit/` directories with project standards, guidelines, and patterns that AI assistants read automatically.
 
@@ -21,7 +21,7 @@ Update `.md` files as your project evolves; the AI follows.
 
 ## Multi-Platform Support
 
-Works with: **Cursor** • **Claude Code** • **GitHub Copilot** • **Codex CLI** • **Gemini CLI** • **Aider** • **Continue** • **Windsurf**
+Works with: **Cursor** • **Claude Code** • **GitHub Copilot** • **Codex CLI** • **OpenCode** • **Gemini CLI** • **Aider** • **Continue** • **Windsurf**
 
 Each platform gets auto-loaded bridge files (`CLAUDE.md`, `AGENTS.md`, `GEMINI.md`, `.windsurfrules`, etc.) so your AI tools read project standards automatically. Claude Code uses `@` imports in CLAUDE.md to load standards content directly into context — no extra token cost from manual file reads.
 
@@ -32,15 +32,19 @@ Each platform gets auto-loaded bridge files (`CLAUDE.md`, `AGENTS.md`, `GEMINI.m
 **Requirements:** Node.js 14.x+ (16.x+ recommended) and npm/yarn. Optional: Git for hooks, AI tools for usage.
 
 ```bash
-# Step 1: Install globally (recommended)
+# Step 1: Install the CLI globally (one-time, any machine)
 npm i -g @nolrm/contextkit
 
-# Step 2: Navigate to your project and install
+# Step 2: Initialize in your project (once per project)
 cd your-project
 contextkit install          # interactive — prompts "Which AI tool?"
 contextkit install claude   # or specify your platform directly
 ```
 
+> **Project-level only.** `ck install` creates `.contextkit/` in your current directory and commits it with your project. There is no global mode — your standards live in git, not on your machine. This keeps them portable, CI-compatible, and shared with your team.
+
+> **Tip:** Need to share standards across projects? Push your `.contextkit/` to a shared repo and pull it with `ck pull`.
+
 This creates `.contextkit/` with skeleton context files (blank templates to be filled by AI):
 
 ```
@@ -76,6 +80,7 @@ ck claude      # creates CLAUDE.md + .claude/rules/
 ck cursor      # creates .cursor/rules/ (scoped .mdc files)
 ck copilot     # creates .github/copilot-instructions.md
 ck codex       # creates AGENTS.md
+ck opencode    # creates AGENTS.md
 ck gemini      # creates GEMINI.md + .gemini/settings.json
 ck aider       # creates CONVENTIONS.md + .aider/rules.md
 ck continue    # creates .continue/rules/ + config.yaml
@@ -136,6 +141,11 @@ claude "create checkout flow for customer"
 codex "create checkout flow for customer"
 ```
 
+**OpenCode** — reads `AGENTS.md` automatically
+```bash
+opencode "create checkout flow for customer"
+```
+
 **CLI** (Chat with AI)
 ```bash
 ck ai "create a button"
@@ -284,7 +294,7 @@ Hooks are optional and can be skipped with `ck install --no-hooks`.
 - 🧠 **Context Engineering** - Structured MD files your AI reads automatically
 - 🔍 **Smart Analysis** - AI generates standards content based on your codebase
 - 🌍 **Project Agnostic** - Works with React, Vue, Node.js, PHP, Python, Rust, monorepos—any project type
-- 🤖 **Multi-Platform** - Works with Cursor, Claude Code, Copilot, Codex, Gemini, Aider, Continue, Windsurf
+- 🤖 **Multi-Platform** - Works with Cursor, Claude Code, Copilot, Codex, OpenCode, Gemini, Aider, Continue, Windsurf
 - 🛡️ **Safe Install** - Backs up existing files with rollback support
 - ⚡ **Zero Config** - Auto-detects project type and package manager
 - ✅ **Policy Enforcement** - Configurable validation with `ck check`
@@ -303,6 +313,7 @@ ck claude      # add Claude Code integration (CLAUDE.md + rules)
 ck cursor      # add Cursor integration (scoped .mdc rules)
 ck copilot     # add GitHub Copilot integration
 ck codex       # add Codex CLI integration (AGENTS.md)
+ck opencode    # add OpenCode integration (AGENTS.md)
 ck gemini      # add Gemini CLI integration (GEMINI.md)
 ck aider       # add Aider integration (CONVENTIONS.md)
 ck continue    # add Continue integration

package/bin/contextkit.js

@@ -22,7 +22,7 @@ program
 // Install command
 program
   .command('install [platform]')
-  .description('Install ContextKit in current project')
+  .description('Initialize ContextKit in the current project directory (run once per project, not global)')
   .option('--no-hooks', 'Skip Git hooks installation')
   .option('--non-interactive', 'Skip interactive prompts')
   .action(async (platform, options) => {
@@ -275,6 +275,19 @@ program
     }
   });
 
+program
+  .command('opencode')
+  .description('Install OpenCode integration only')
+  .option('--non-interactive', 'Skip interactive prompts')
+  .action(async (options) => {
+    try {
+      await install({ platform: 'opencode', ...options });
+    } catch (error) {
+      console.error(chalk.red('Installation failed:'), error.message);
+      process.exit(1);
+    }
+  });
+
 program
   .command('copilot')
   .description('Install GitHub Copilot integration only')

package/lib/commands/install.js

@@ -36,6 +36,15 @@ class InstallCommand {
       console.log(chalk.yellow('🧹 Removed legacy pre-commit hook (replaced by pre-push)'));
     }
 
+    // Warn if run outside a project directory
+    const hasGit = await this._findFileUpward('.git', 3);
+    const hasPkg = await fs.pathExists('package.json');
+    if (!hasGit && !hasPkg) {
+      console.log(chalk.yellow('⚠️  No project detected (no .git or package.json found in this directory).'));
+      console.log(chalk.yellow('   Make sure you are inside your project before running `ck install`.'));
+      console.log('');
+    }
+
     const requestedPlatform = options.platform;
     const isFullInstall = !!options.fullInstall;
 
@@ -127,7 +136,7 @@ class InstallCommand {
 
       if (!integration) {
         console.log(chalk.red(`❌ Unknown platform: ${platform}`));
-        console.log(chalk.yellow('💡 Available: claude, cursor, copilot, codex, gemini, aider, continue, windsurf'));
+        console.log(chalk.yellow('💡 Available: claude, cursor, copilot, codex, opencode, gemini, aider, continue, windsurf'));
         return;
       }
 
@@ -178,6 +187,7 @@ class InstallCommand {
         { name: 'Cursor', value: 'cursor' },
         { name: 'Copilot (GitHub)', value: 'copilot' },
         { name: 'Codex (OpenAI)', value: 'codex' },
+        { name: 'OpenCode', value: 'opencode' },
         { name: 'Gemini', value: 'gemini' },
         { name: 'Windsurf', value: 'windsurf' },
         { name: 'Aider', value: 'aider' },
@@ -1515,7 +1525,7 @@ If standards are still skeletons, warn that @imports in CLAUDE.md are loading em
     console.log(''.padEnd(48, '─'));
     console.log(`ck status    → Check installation & integrations`);
     console.log(`ck ai <cmd>  → Use AI with project context`);
-    console.log(`ck <platform> → Add platform (claude, cursor, copilot, codex, gemini, aider, continue, windsurf)`);
+    console.log(`ck <platform> → Add platform (claude, cursor, copilot, codex, opencode, gemini, aider, continue, windsurf)`);
     console.log('');
     console.log(`Docs → ${chalk.blue('https://contextkit-docs.vercel.app')}`);
     console.log(`Issues → ${chalk.blue('https://github.com/nolrm/contextkit/issues')}`);
@@ -1573,6 +1583,17 @@ If standards are still skeletons, warn that @imports in CLAUDE.md are loading em
     console.log(chalk.magenta('✨ Done! Your AI now understands your project.'));
     console.log('');
   }
+
+  async _findFileUpward(name, maxLevels) {
+    let dir = process.cwd();
+    for (let i = 0; i <= maxLevels; i++) {
+      if (await fs.pathExists(path.join(dir, name))) return true;
+      const parent = path.dirname(dir);
+      if (parent === dir) break;
+      dir = parent;
+    }
+    return false;
+  }
 }
 
 async function install(options) {

package/lib/integrations/index.js

@@ -2,6 +2,7 @@ const ClaudeIntegration = require('./claude-integration');
 const CursorIntegration = require('./cursor-integration');
 const CopilotIntegration = require('./copilot-integration');
 const CodexIntegration = require('./codex-integration');
+const OpencodeIntegration = require('./opencode-integration');
 const GeminiIntegration = require('./gemini-integration');
 const AiderIntegration = require('./aider-integration');
 const ContinueIntegration = require('./continue-integration');
@@ -13,6 +14,7 @@ const INTEGRATIONS = {
   copilot: CopilotIntegration,
   vscode: CopilotIntegration, // backward compat alias
   codex: CodexIntegration,
+  opencode: OpencodeIntegration,
   gemini: GeminiIntegration,
   aider: AiderIntegration,
   continue: ContinueIntegration,
@@ -27,7 +29,7 @@ function getIntegration(name) {
 
 function getAllIntegrationNames() {
   // Return unique names (exclude aliases like vscode)
-  return ['claude', 'cursor', 'copilot', 'codex', 'gemini', 'aider', 'continue', 'windsurf'];
+  return ['claude', 'cursor', 'copilot', 'codex', 'opencode', 'gemini', 'aider', 'continue', 'windsurf'];
 }
 
 module.exports = { getIntegration, getAllIntegrationNames, INTEGRATIONS };

package/lib/integrations/opencode-integration.js

@@ -0,0 +1,45 @@
+const chalk = require('chalk');
+const BaseIntegration = require('./base-integration');
+
+class OpencodeIntegration extends BaseIntegration {
+  constructor() {
+    super();
+    this.name = 'opencode';
+    this.displayName = 'OpenCode';
+    this.bridgeFiles = ['AGENTS.md'];
+    this.generatedFiles = [];
+    this.platformDir = '';
+  }
+
+  async generateFiles() {
+    // Bridge file: AGENTS.md (auto-loaded by OpenCode)
+    const bridgeContent = `# Project Standards (ContextKit)
+
+This project uses [ContextKit](https://github.com/nolrm/contextkit) for AI development standards.
+
+${this.getStandardsBlock()}
+
+## Corrections Log
+
+- \`.contextkit/corrections.md\` — Track AI performance improvements
+
+## Quick Reference
+
+Before writing code, check the relevant standards files above. Always follow the project's established patterns and conventions.`;
+
+    await this.writeBridgeFile('AGENTS.md', bridgeContent);
+  }
+
+  showUsage() {
+    console.log('');
+    console.log(chalk.bold('  OpenCode Usage:'));
+    console.log('    AGENTS.md is auto-loaded by OpenCode');
+    console.log('    Just run: opencode "create a button component"');
+    console.log('    Standards are automatically included via AGENTS.md');
+    console.log('');
+    console.log(chalk.dim('  Files created:'));
+    console.log(chalk.dim('    AGENTS.md (bridge - auto-loaded)'));
+  }
+}
+
+module.exports = OpencodeIntegration;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nolrm/contextkit",
-  "version": "0.11.0",
+  "version": "0.12.4",
   "description": "ContextKit - Context Engineering for AI Development. Provide rich context to AI through structured MD files with standards, code guides, and documentation. Works with Cursor, Claude, Aider, VS Code Copilot, and more.",
   "main": "lib/index.js",
   "bin": {