clavix 2.2.0 → 2.3.0

package/README.md

@@ -19,8 +19,8 @@ Clavix is built on CLEAR (Concise, Logical, Explicit, Adaptive, Reflective), an
 | Category | Providers |
 | --- | --- |
 | IDE & editor extensions | Cursor · Windsurf · Kilocode · Roocode · Cline |
-| CLI agents | Claude Code · Droid CLI · CodeBuddy CLI · OpenCode · Gemini CLI · Qwen Code · Amp · Crush CLI · Codex CLI |
-| Universal adapters | AGENTS.md · OCTO.md · WARP.md |
+| CLI agents | Claude Code · Droid CLI · CodeBuddy CLI · OpenCode · Gemini CLI · Qwen Code · Amp · Crush CLI · Codex CLI · Augment CLI |
+| Universal adapters | AGENTS.md · GitHub Copilot · OCTO.md · WARP.md |
 
 Provider paths and argument placeholders are listed in [docs/providers.md](docs/providers.md).
 

package/dist/cli/commands/init.js

@@ -46,6 +46,7 @@ const doc_injector_1 = require("../../core/doc-injector");
 const agents_md_generator_1 = require("../../core/adapters/agents-md-generator");
 const octo_md_generator_1 = require("../../core/adapters/octo-md-generator");
 const warp_md_generator_1 = require("../../core/adapters/warp-md-generator");
+const copilot_instructions_generator_1 = require("../../core/adapters/copilot-instructions-generator");
 const file_system_1 = require("../../utils/file-system");
 const config_1 = require("../../types/config");
 const gemini_adapter_1 = require("../../core/adapters/gemini-adapter");
@@ -98,10 +99,6 @@ class Init extends core_1.Command {
                             name: 'CodeBuddy (.codebuddy/commands/)',
                             value: 'codebuddy',
                         },
-                        {
-                            name: 'Copilot CLI (.github/agents/)',
-                            value: 'copilot',
-                        },
                         {
                             name: 'Crush CLI (.crush/commands/clavix/)',
                             value: 'crush',
@@ -154,6 +151,10 @@ class Init extends core_1.Command {
                             name: 'agents.md (Universal - for tools without slash commands)',
                             value: 'agents-md',
                         },
+                        {
+                            name: 'GitHub Copilot (.github/copilot-instructions.md)',
+                            value: 'copilot-instructions',
+                        },
                         {
                             name: 'Warp (WARP.md - optimized for Warp)',
                             value: 'warp-md',
@@ -193,6 +194,12 @@ class Init extends core_1.Command {
                     await agents_md_generator_1.AgentsMdGenerator.generate();
                     continue;
                 }
+                // Handle copilot-instructions separately (it's not an adapter)
+                if (providerName === 'copilot-instructions') {
+                    console.log(chalk_1.default.gray('  ✓ Generating .github/copilot-instructions.md...'));
+                    await copilot_instructions_generator_1.CopilotInstructionsGenerator.generate();
+                    continue;
+                }
                 // Handle octo-md separately (it's not an adapter)
                 if (providerName === 'octo-md') {
                     console.log(chalk_1.default.gray('  ✓ Generating OCTO.md...'));

package/dist/core/adapters/copilot-instructions-generator.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Generator for GitHub Copilot instructions file
+ * Provides workflow instructions via .github/copilot-instructions.md
+ */
+export declare class CopilotInstructionsGenerator {
+    static readonly TARGET_FILE = ".github/copilot-instructions.md";
+    static readonly START_MARKER = "<!-- CLAVIX:START -->";
+    static readonly END_MARKER = "<!-- CLAVIX:END -->";
+    /**
+     * Generate or update .github/copilot-instructions.md with Clavix workflows
+     */
+    static generate(): Promise<void>;
+    /**
+     * Inject or update managed block in .github/copilot-instructions.md
+     */
+    private static injectManagedBlock;
+    /**
+     * Escape special regex characters
+     */
+    private static escapeRegex;
+    /**
+     * Check if .github/copilot-instructions.md has Clavix block
+     */
+    static hasClavixBlock(): Promise<boolean>;
+}
+//# sourceMappingURL=copilot-instructions-generator.d.ts.map

package/dist/core/adapters/copilot-instructions-generator.js

@@ -0,0 +1,104 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopilotInstructionsGenerator = void 0;
+const file_system_1 = require("../../utils/file-system");
+const path = __importStar(require("path"));
+/**
+ * Generator for GitHub Copilot instructions file
+ * Provides workflow instructions via .github/copilot-instructions.md
+ */
+class CopilotInstructionsGenerator {
+    /**
+     * Generate or update .github/copilot-instructions.md with Clavix workflows
+     */
+    static async generate() {
+        const templatePath = path.join(__dirname, '../../templates/agents/copilot-instructions.md');
+        // Check if template exists
+        if (!(await file_system_1.FileSystem.exists(templatePath))) {
+            throw new Error(`Copilot instructions template not found at ${templatePath}`);
+        }
+        const template = await file_system_1.FileSystem.readFile(templatePath);
+        // Ensure .github directory exists
+        await file_system_1.FileSystem.ensureDir('.github');
+        // Inject into .github/copilot-instructions.md using managed blocks
+        await this.injectManagedBlock(this.TARGET_FILE, template);
+    }
+    /**
+     * Inject or update managed block in .github/copilot-instructions.md
+     */
+    static async injectManagedBlock(filePath, content) {
+        let fileContent = '';
+        // Read existing file or start with empty content
+        if (await file_system_1.FileSystem.exists(filePath)) {
+            fileContent = await file_system_1.FileSystem.readFile(filePath);
+        }
+        const blockRegex = new RegExp(`${this.escapeRegex(this.START_MARKER)}[\\s\\S]*?${this.escapeRegex(this.END_MARKER)}`, 'g');
+        const wrappedContent = `${this.START_MARKER}\n${content}\n${this.END_MARKER}`;
+        if (blockRegex.test(fileContent)) {
+            // Replace existing block
+            fileContent = fileContent.replace(blockRegex, wrappedContent);
+        }
+        else {
+            // Append new block
+            if (fileContent && !fileContent.endsWith('\n\n')) {
+                fileContent += '\n\n';
+            }
+            fileContent += wrappedContent + '\n';
+        }
+        await file_system_1.FileSystem.writeFileAtomic(filePath, fileContent);
+    }
+    /**
+     * Escape special regex characters
+     */
+    static escapeRegex(str) {
+        return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+    }
+    /**
+     * Check if .github/copilot-instructions.md has Clavix block
+     */
+    static async hasClavixBlock() {
+        if (!(await file_system_1.FileSystem.exists(this.TARGET_FILE))) {
+            return false;
+        }
+        const content = await file_system_1.FileSystem.readFile(this.TARGET_FILE);
+        return content.includes(this.START_MARKER);
+    }
+}
+exports.CopilotInstructionsGenerator = CopilotInstructionsGenerator;
+CopilotInstructionsGenerator.TARGET_FILE = '.github/copilot-instructions.md';
+CopilotInstructionsGenerator.START_MARKER = '<!-- CLAVIX:START -->';
+CopilotInstructionsGenerator.END_MARKER = '<!-- CLAVIX:END -->';
+//# sourceMappingURL=copilot-instructions-generator.js.map

package/dist/core/agent-manager.js

@@ -17,7 +17,6 @@ const gemini_adapter_1 = require("./adapters/gemini-adapter");
 const qwen_adapter_1 = require("./adapters/qwen-adapter");
 const codex_adapter_1 = require("./adapters/codex-adapter");
 const augment_adapter_1 = require("./adapters/augment-adapter");
-const copilot_adapter_1 = require("./adapters/copilot-adapter");
 /**
  * Agent Manager - handles agent detection and registration
  */
@@ -40,7 +39,6 @@ class AgentManager {
         this.registerAdapter(new gemini_adapter_1.GeminiAdapter());
         this.registerAdapter(new qwen_adapter_1.QwenAdapter());
         this.registerAdapter(new codex_adapter_1.CodexAdapter());
-        this.registerAdapter(new copilot_adapter_1.CopilotAdapter());
     }
     /**
      * Register a new agent adapter

package/dist/templates/agents/copilot-instructions.md

@@ -0,0 +1,90 @@
+# Clavix Workflows for GitHub Copilot
+
+These instructions enhance GitHub Copilot's understanding of the Clavix prompt engineering framework and workflow commands available in this project.
+
+## About Clavix
+
+Clavix is a CLEAR Framework-validated prompt engineering toolkit that helps improve prompts, generate PRDs, and manage implementation workflows. The CLEAR Framework (Concise, Logical, Explicit, Adaptive, Reflective) is an academically-validated approach developed by Dr. Leo Lo at the University of New Mexico.
+
+## Available Commands
+
+When working with this project, you can use the following Clavix commands:
+
+### Prompt Improvement
+- `clavix fast "<prompt>"` - Quick CLEAR analysis (C/L/E components) with improved prompt output
+- `clavix deep "<prompt>"` - Comprehensive CLEAR analysis (all 5 components: C/L/E/A/R) with alternatives and validation
+
+### Strategic Planning
+- `clavix prd` - Interactive PRD generation through Socratic questioning
+- `clavix plan` - Transform PRDs into phase-based implementation tasks
+- `clavix implement` - Execute tasks with progress tracking
+
+### Conversational Workflows
+- `clavix start` - Begin conversational session for requirements gathering
+- `clavix summarize [session-id]` - Extract mini-PRD and optimized prompts from sessions
+
+### Project Management
+- `clavix list` - List sessions and output projects
+- `clavix show [session-id]` - Inspect session or project details
+- `clavix archive [project]` - Archive or restore completed projects
+- `clavix update` - Refresh Clavix documentation and commands
+
+## Workflow Patterns
+
+### Quick Prompt Improvement
+1. User provides a rough prompt
+2. Run `clavix fast "<prompt>"` for quick CLEAR-validated improvements
+3. Use the optimized prompt for better results
+
+### Comprehensive Prompt Analysis
+1. User has a complex requirement
+2. Run `clavix deep "<prompt>"` for full CLEAR analysis
+3. Review alternative variations and validation checklists
+4. Select the best approach
+
+### Strategic Project Planning
+1. Run `clavix prd` to generate a comprehensive PRD through guided questions
+2. Run `clavix plan` to break down the PRD into implementation tasks
+3. Run `clavix implement` to execute tasks systematically
+4. Archive completed work with `clavix archive`
+
+### Conversational Requirements Gathering
+1. Run `clavix start` to begin capturing a conversation
+2. Discuss requirements naturally with the user
+3. Run `clavix summarize` to extract structured requirements and prompts
+
+## CLEAR Framework Components
+
+When analyzing or improving prompts, apply these CLEAR Framework principles:
+
+- **[C] Concise**: Remove verbosity, pleasantries, unnecessary qualifiers
+- **[L] Logical**: Ensure coherent sequencing (context → requirements → constraints → output)
+- **[E] Explicit**: Add clear specifications for persona, format, tone, success criteria
+- **[A] Adaptive**: Provide alternative phrasings and flexible structures
+- **[R] Reflective**: Include validation checklists and quality criteria
+
+## Output Locations
+
+Clavix stores artifacts in the `.clavix/` directory:
+- `.clavix/outputs/<project>/` - PRDs, tasks, and optimized prompts
+- `.clavix/sessions/` - Captured conversational sessions
+- `.clavix/templates/` - Custom template overrides
+- `.clavix/config.json` - Project configuration
+
+## Best Practices
+
+1. **Start with the right mode**: Use fast mode for simple prompts, deep mode for complex requirements, and PRD mode for strategic planning
+2. **Leverage CLEAR Framework**: Always consider the 5 CLEAR components when crafting prompts
+3. **Document requirements**: Use PRD workflow for significant features to ensure clear requirements
+4. **Track progress**: Use implement command to maintain structured task execution
+5. **Archive completed work**: Keep project organized by archiving finished projects
+
+## Integration with GitHub Copilot
+
+When users ask for help with prompts or requirements:
+1. Suggest running the appropriate Clavix command
+2. Explain the expected output and benefits
+3. Help interpret Clavix-generated outputs
+4. Apply CLEAR Framework principles in your responses
+
+This integration makes GitHub Copilot aware of Clavix workflows and can suggest using Clavix commands when appropriate.

package/dist/types/agent.d.ts

@@ -37,5 +37,5 @@ export interface ManagedBlock {
     content: string;
     targetFile: string;
 }
-export type AgentType = 'agents-md' | 'amp' | 'augment' | 'claude-code' | 'cline' | 'codex' | 'codebuddy' | 'copilot' | 'crush' | 'cursor' | 'custom' | 'droid' | 'gemini' | 'kilocode' | 'octo-md' | 'opencode' | 'qwen' | 'roocode' | 'windsurf';
+export type AgentType = 'agents-md' | 'amp' | 'augment' | 'claude-code' | 'cline' | 'codex' | 'codebuddy' | 'copilot-instructions' | 'crush' | 'cursor' | 'custom' | 'droid' | 'gemini' | 'kilocode' | 'octo-md' | 'opencode' | 'qwen' | 'roocode' | 'windsurf';
 //# sourceMappingURL=agent.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clavix",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Transform vague ideas into production-ready prompts. CLI tool using the CLEAR framework to analyze, improve, and generate PRDs for AI coding assistants (Claude Code, Cursor, Windsurf, and more)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/core/adapters/copilot-adapter.d.ts

@@ -1,24 +0,0 @@
-import { BaseAdapter } from './base-adapter';
-import { CommandTemplate } from '../../types/agent';
-/**
- * GitHub Copilot CLI adapter (custom agents)
- * Generates agent profiles under .github/agents
- */
-export declare class CopilotAdapter extends BaseAdapter {
-    readonly name = "copilot";
-    readonly displayName = "Copilot CLI";
-    readonly directory = ".github/agents";
-    readonly fileExtension = ".agent.md";
-    readonly features: {
-        supportsSubdirectories: boolean;
-        supportsFrontmatter: boolean;
-        frontmatterFields: string[];
-    };
-    detectProject(): Promise<boolean>;
-    getCommandPath(): string;
-    getTargetFilename(name: string): string;
-    protected formatCommand(template: CommandTemplate): string;
-    private toTitle;
-    private getHomeDir;
-}
-//# sourceMappingURL=copilot-adapter.d.ts.map

package/dist/core/adapters/copilot-adapter.js

@@ -1,88 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CopilotAdapter = void 0;
-const os = __importStar(require("os"));
-const path = __importStar(require("path"));
-const base_adapter_1 = require("./base-adapter");
-const file_system_1 = require("../../utils/file-system");
-/**
- * GitHub Copilot CLI adapter (custom agents)
- * Generates agent profiles under .github/agents
- */
-class CopilotAdapter extends base_adapter_1.BaseAdapter {
-    constructor() {
-        super(...arguments);
-        this.name = 'copilot';
-        this.displayName = 'Copilot CLI';
-        this.directory = '.github/agents';
-        this.fileExtension = '.agent.md';
-        this.features = {
-            supportsSubdirectories: false,
-            supportsFrontmatter: true,
-            frontmatterFields: ['name', 'description', 'tools', 'target'],
-        };
-    }
-    async detectProject() {
-        if (await file_system_1.FileSystem.exists('.github/agents')) {
-            return true;
-        }
-        const homeAgentsDir = path.join(this.getHomeDir(), '.copilot', 'agents');
-        return file_system_1.FileSystem.exists(homeAgentsDir);
-    }
-    getCommandPath() {
-        return this.directory;
-    }
-    getTargetFilename(name) {
-        return `clavix-${name}${this.fileExtension}`;
-    }
-    formatCommand(template) {
-        const displayName = `Clavix: ${this.toTitle(template.name)}`;
-        const frontmatter = `---\nname: ${displayName}\ndescription: ${template.description}\n---\n\n`;
-        return frontmatter + template.content;
-    }
-    toTitle(value) {
-        return value
-            .split(/[-_\s]+/)
-            .filter(Boolean)
-            .map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1))
-            .join(' ');
-    }
-    getHomeDir() {
-        return process.env.CLAVIX_HOME_OVERRIDE || os.homedir();
-    }
-}
-exports.CopilotAdapter = CopilotAdapter;
-//# sourceMappingURL=copilot-adapter.js.map