nia-opencode 0.1.0 → 0.1.2

package/dist/cli.js

@@ -7,7 +7,28 @@ import { homedir } from "node:os";
 import * as readline from "node:readline";
 var OPENCODE_CONFIG_DIR = join(homedir(), ".config", "opencode");
 var NIA_CONFIG_PATH = join(OPENCODE_CONFIG_DIR, "nia.json");
+var AGENTS_MD_PATH = join(OPENCODE_CONFIG_DIR, "AGENTS.md");
 var PLUGIN_NAME = "nia-opencode@latest";
+var NIA_AGENTS_INSTRUCTIONS = `
+# How to use Nia
+
+Nia provides tools for indexing and searching external repositories, research papers, local folders, documentation, packages, and performing AI-powered research. Its primary goal is to reduce hallucinations in LLMs and provide up-to-date context for AI agents.
+
+## Deterministic Workflow
+
+1. Check if the source is already indexed using manage_resource (when listing sources, use targeted query to save tokens since users can have multiple sources indexed) or check any nia.md files for already indexed sources.
+2. If it is indexed, check the tree of the source or ls relevant directories.
+3. After getting the grasp of the structure (tree), use 'search', 'nia_grep', 'nia_read' for targeted searches.
+4. If helpful, use the context tool to save your research findings to make them reusable for future conversations.
+5. Save your findings in an .md file to track: source indexed, used, its ID, and link so you won't have to list sources in the future and can get straight to work.
+
+## Notes
+
+- DO NOT USE WEB RESEARCH TOOLS IF INFORMATION IS INDEXED IN NIA BY USING 'manage_resource' tool.
+- If the source isn't indexed, index it. Note that for docs you should always index the root link like docs.stripe.com so it will always scrape all pages.
+- If you need to index something but don't know the link for that source, use nia_research (quick or deep modes).
+- Once you use the index tool, do not expect it to finish in 1-3 seconds. Stop your work or do something that will make your work pause for 1-5 minutes until the source is indexed, then run manage_resource again to check its status. You can also prompt the user to wait if needed.
+`;
 function stripJsoncComments(content) {
   return content.replace(/\/\*[\s\S]*?\*\//g, "").replace(/\/\/.*$/gm, "");
 }
@@ -155,6 +176,32 @@ function createNiaConfig(apiKey) {
   console.log(`  Created ${NIA_CONFIG_PATH}`);
   return true;
 }
+function updateAgentsMd() {
+  mkdirSync(OPENCODE_CONFIG_DIR, { recursive: true });
+  try {
+    if (existsSync(AGENTS_MD_PATH)) {
+      const content = readFileSync(AGENTS_MD_PATH, "utf-8");
+      if (content.includes("# How to use Nia")) {
+        console.log("  Nia instructions already in AGENTS.md");
+        return true;
+      }
+      const newContent = content.trimEnd() + `
+
+` + NIA_AGENTS_INSTRUCTIONS.trim() + `
+`;
+      writeFileSync(AGENTS_MD_PATH, newContent);
+      console.log("  Appended Nia instructions to AGENTS.md");
+    } else {
+      writeFileSync(AGENTS_MD_PATH, NIA_AGENTS_INSTRUCTIONS.trim() + `
+`);
+      console.log(`  Created ${AGENTS_MD_PATH} with Nia instructions`);
+    }
+    return true;
+  } catch (err) {
+    console.error("  Failed to update AGENTS.md:", err);
+    return false;
+  }
+}
 async function install(options) {
   console.log(`
  Nia OpenCode Plugin Installer
@@ -216,6 +263,18 @@ Step 3: Configure OpenCode`);
     }
   }
   console.log(`
+Step 4: Add Nia Instructions to AGENTS.md`);
+  if (options.tui && rl) {
+    const shouldUpdate = await confirm(rl, "Add Nia usage instructions to ~/.config/opencode/AGENTS.md?");
+    if (shouldUpdate) {
+      updateAgentsMd();
+    } else {
+      console.log("  Skipped.");
+    }
+  } else {
+    updateAgentsMd();
+  }
+  console.log(`
 ` + "-".repeat(50));
   console.log(`
  Setup Complete!

package/dist/index.js

@@ -46,7 +46,7 @@ function isConfigured() {
 // src/keywords.ts
 var CODE_BLOCK_PATTERN = /```[\s\S]*?```/g;
 var INLINE_CODE_PATTERN = /`[^`]+`/g;
-var DEFAULT_PATTERNS = [
+var RESEARCH_PATTERNS = [
   /\b(research|look\s*up|find\s*docs?)\b/i,
   /\b(search\s+for|search\s+codebase|search\s+repo|search\s+docs?)\b/i,
   /\b(grep\s+for|grep\s+in)\b/i,
@@ -55,6 +55,14 @@ var DEFAULT_PATTERNS = [
   /\bcheck\s+(the\s+)?(docs?|documentation)\s+(for|about|on)\b/i,
   /\bfind\s+(examples?|usage)\s+(of|for)\b/i
 ];
+var SAVE_PATTERNS = [
+  /\b(save\s+(this\s+)?(context|conversation|session|chat))\b/i,
+  /\b(continue\s+(this\s+)?(later|tomorrow|in\s+\w+))\b/i,
+  /\b(pick\s+(this\s+)?up\s+(later|tomorrow|in\s+\w+))\b/i,
+  /\b(hand\s*off|switch(ing)?\s+to)\s+(cursor|claude|windsurf|copilot|another\s+agent)\b/i,
+  /\b(save\s+for\s+later|bookmark\s+this)\b/i,
+  /\b(preserve|store)\s+(this\s+)?(context|conversation|session)\b/i
+];
 function removeCodeBlocks(text) {
   return text.replace(CODE_BLOCK_PATTERN, "").replace(INLINE_CODE_PATTERN, "");
 }
@@ -67,19 +75,25 @@ function compileCustomPatterns() {
     }
   }).filter((p) => p !== null);
 }
-function detectResearchKeyword(text) {
+function detectKeyword(text) {
   if (!CONFIG.keywords.enabled) {
-    return { detected: false };
+    return { type: null };
   }
   const textWithoutCode = removeCodeBlocks(text);
-  const allPatterns = [...DEFAULT_PATTERNS, ...compileCustomPatterns()];
-  for (const pattern of allPatterns) {
+  for (const pattern of SAVE_PATTERNS) {
+    const match = textWithoutCode.match(pattern);
+    if (match) {
+      return { type: "save", match: match[0] };
+    }
+  }
+  const researchPatterns = [...RESEARCH_PATTERNS, ...compileCustomPatterns()];
+  for (const pattern of researchPatterns) {
     const match = textWithoutCode.match(pattern);
     if (match) {
-      return { detected: true, match: match[0] };
+      return { type: "research", match: match[0] };
     }
   }
-  return { detected: false };
+  return { type: null };
 }
 var NIA_NUDGE_MESSAGE = `[NIA KNOWLEDGE TRIGGER]
 The user is asking for research, documentation, or codebase exploration. You have access to **Nia** tools via MCP.
@@ -99,6 +113,30 @@ The user is asking for research, documentation, or codebase exploration. You hav
 3. Read specific files if needed for deeper context
 
 Use these tools to provide accurate, up-to-date information instead of relying solely on training data.`;
+var NIA_SAVE_NUDGE_MESSAGE = `[NIA CONTEXT SAVE TRIGGER]
+The user wants to save this conversation to continue later or hand off to another agent.
+
+**Use \`nia.context\` to save:**
+\`\`\`
+nia.context({
+  action: "save",
+  title: "Brief title describing this session",
+  summary: "What was accomplished and what's pending",
+  content: "Key decisions, code snippets, and important context",
+  tags: ["relevant", "tags"],
+  edited_files: [{ path: "file/path.ts", action: "modified" }]
+})
+\`\`\`
+
+**What to include:**
+- Summary of what was discussed/accomplished
+- Key decisions made
+- Code snippets or plans created
+- Files that were edited
+- Next steps or pending tasks
+- Any Nia sources that were referenced
+
+This context can be loaded in Cursor, Claude Code, Windsurf, or any agent with Nia access.`;
 
 // src/services/logger.ts
 var DEBUG = process.env.NIA_DEBUG === "true" || process.env.NIA_DEBUG === "1";
@@ -143,20 +181,21 @@ var NiaPlugin = async (ctx) => {
           messagePreview: userMessage.slice(0, 100),
           partsCount: output.parts.length
         });
-        const { detected, match } = detectResearchKeyword(userMessage);
-        if (detected) {
-          log("chat.message: research keyword detected", { match });
+        const { type, match } = detectKeyword(userMessage);
+        if (type) {
+          const nudgeText = type === "save" ? NIA_SAVE_NUDGE_MESSAGE : NIA_NUDGE_MESSAGE;
+          log(`chat.message: ${type} keyword detected`, { match });
           const nudgePart = {
-            id: `nia-nudge-${Date.now()}`,
+            id: `nia-${type}-nudge-${Date.now()}`,
             sessionID: input.sessionID,
             messageID: output.message.id,
             type: "text",
-            text: NIA_NUDGE_MESSAGE,
+            text: nudgeText,
             synthetic: true
           };
           output.parts.push(nudgePart);
           const duration = Date.now() - start;
-          log("chat.message: nudge injected", { duration, match });
+          log(`chat.message: ${type} nudge injected`, { duration, match });
         }
       } catch (error) {
         log("chat.message: ERROR", { error: String(error) });

package/dist/keywords.d.ts

@@ -1,5 +1,11 @@
+export type KeywordType = "research" | "save" | null;
+export declare function detectKeyword(text: string): {
+    type: KeywordType;
+    match?: string;
+};
 export declare function detectResearchKeyword(text: string): {
     detected: boolean;
     match?: string;
 };
 export declare const NIA_NUDGE_MESSAGE = "[NIA KNOWLEDGE TRIGGER]\nThe user is asking for research, documentation, or codebase exploration. You have access to **Nia** tools via MCP.\n\n**Available Nia tools:**\n- `nia.search` - Semantic search across indexed repos, docs, and papers\n- `nia.nia_research` - Web search (quick) or deep AI research (deep/oracle modes)\n- `nia.index` - Index new GitHub repos, documentation sites, or arXiv papers\n- `nia.nia_read` - Read specific files from indexed sources\n- `nia.nia_grep` - Regex search across indexed codebases\n- `nia.nia_explore` - Browse file trees of indexed repos/docs\n- `nia.manage_resource` - List/check status of indexed sources\n\n**Workflow:**\n1. Check what's indexed: `nia.manage_resource(action: \"list\")`\n2. Search or research based on the user's question\n3. Read specific files if needed for deeper context\n\nUse these tools to provide accurate, up-to-date information instead of relying solely on training data.";
+export declare const NIA_SAVE_NUDGE_MESSAGE = "[NIA CONTEXT SAVE TRIGGER]\nThe user wants to save this conversation to continue later or hand off to another agent.\n\n**Use `nia.context` to save:**\n```\nnia.context({\n  action: \"save\",\n  title: \"Brief title describing this session\",\n  summary: \"What was accomplished and what's pending\",\n  content: \"Key decisions, code snippets, and important context\",\n  tags: [\"relevant\", \"tags\"],\n  edited_files: [{ path: \"file/path.ts\", action: \"modified\" }]\n})\n```\n\n**What to include:**\n- Summary of what was discussed/accomplished\n- Key decisions made\n- Code snippets or plans created\n- Files that were edited\n- Next steps or pending tasks\n- Any Nia sources that were referenced\n\nThis context can be loaded in Cursor, Claude Code, Windsurf, or any agent with Nia access.";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nia-opencode",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "OpenCode plugin that integrates Nia Knowledge Agent for research and documentation",
   "type": "module",
   "main": "dist/index.js",