nia-opencode 0.1.0 → 0.1.1

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/package.json

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