openviking-opencode 0.1.0

package/index.mjs

@@ -0,0 +1,90 @@
+import { exec } from "child_process"
+import { promisify } from "util"
+import { readFileSync, mkdirSync, writeFileSync, existsSync } from "fs"
+import { homedir } from "os"
+import { join, dirname } from "path"
+import { fileURLToPath } from "url"
+
+const execAsync = promisify(exec)
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
+// ── Skill auto-install ────────────────────────────────────────────────────────
+
+function installSkill() {
+  const src = join(__dirname, "skills", "openviking", "SKILL.md")
+  const dest = join(homedir(), ".config", "opencode", "skills", "openviking", "SKILL.md")
+  const destDir = dirname(dest)
+  try {
+    if (!existsSync(destDir)) mkdirSync(destDir, { recursive: true })
+    const content = readFileSync(src, "utf8")
+    // Only overwrite if content changed (avoid unnecessary disk writes)
+    if (!existsSync(dest) || readFileSync(dest, "utf8") !== content) {
+      writeFileSync(dest, content, "utf8")
+    }
+  } catch {
+    // Non-fatal — skill stays as-is or isn't installed
+  }
+}
+
+// ── Repo context cache ────────────────────────────────────────────────────────
+
+let cachedRepos = null
+let lastFetchTime = 0
+const CACHE_TTL_MS = 60 * 1000
+
+async function loadRepos() {
+  const now = Date.now()
+  if (cachedRepos !== null && now - lastFetchTime < CACHE_TTL_MS) return
+
+  try {
+    const { stdout } = await execAsync(
+      "openviking --output json ls viking://resources/ --abs-limit 2000",
+      { timeout: 8000 }
+    )
+    const parsed = JSON.parse(stdout)
+    const items = parsed?.result ?? []
+    const repos = items
+      .filter((item) => item.uri?.startsWith("viking://resources/"))
+      .map((item) => {
+        const name = item.uri.replace("viking://resources/", "").replace(/\/$/, "")
+        return item.abstract
+          ? `- **${name}** (${item.uri})\n  ${item.abstract}`
+          : `- **${name}** (${item.uri})`
+      })
+
+    if (repos.length > 0) {
+      cachedRepos = repos.join("\n")
+      lastFetchTime = now
+    }
+  } catch {
+    // openviking not running — plugin is a no-op until it is
+  }
+}
+
+// ── Plugin export ─────────────────────────────────────────────────────────────
+
+/**
+ * @type {import('@opencode-ai/plugin').Plugin}
+ */
+export async function OpenVikingPlugin() {
+  installSkill()
+  await loadRepos()
+
+  return {
+    "experimental.chat.system.transform": (_input, output) => {
+      if (!cachedRepos) return
+      output.system.push(
+        `## OpenViking — Indexed Code Repositories\n\n` +
+        `The following repos are semantically indexed and searchable.\n` +
+        `When the user asks about any of these projects or their internals, ` +
+        `you MUST proactively call skill("openviking") before answering.\n\n` +
+        cachedRepos
+      )
+    },
+
+    "session.created": async () => {
+      cachedRepos = null
+      await loadRepos()
+    },
+  }
+}

package/openviking-context.ts

@@ -0,0 +1,60 @@
+import { exec } from "child_process"
+import { promisify } from "util"
+
+const execAsync = promisify(exec)
+
+let cachedRepos: string | null = null
+
+async function loadRepos(): Promise<void> {
+  try {
+    const { stdout } = await execAsync(
+      "openviking --output json ls viking://resources/ --abs-limit 2000",
+      { timeout: 8000 }
+    )
+    const parsed = JSON.parse(stdout)
+    const items: Array<{ uri: string; abstract?: string }> = parsed?.result ?? []
+    const repos = items
+      .filter((item) => item.uri?.startsWith("viking://resources/"))
+      .map((item) => {
+        const name = item.uri.replace("viking://resources/", "").replace(/\/$/, "")
+        return item.abstract
+          ? `- **${name}** (${item.uri})\n  ${item.abstract}`
+          : `- **${name}** (${item.uri})`
+      })
+    if (repos.length > 0) {
+      cachedRepos = repos.join("\n")
+    }
+  } catch {
+    // openviking not available — plugin is a no-op
+  }
+}
+
+/**
+ * @type {import('@opencode-ai/plugin').Plugin}
+ */
+export async function OpenVikingContextPlugin() {
+  // Fetch repos at startup so the cache is ready before any request
+  await loadRepos()
+
+  return {
+    // Inject repo list into every LLM request's system prompt (sync — no await)
+    "experimental.chat.system.transform": (
+      _input: unknown,
+      output: { system: string[] }
+    ) => {
+      if (!cachedRepos) return
+      output.system.push(
+        `## OpenViking — Indexed Code Repositories\n\n` +
+        `The following repos are semantically indexed and searchable.\n` +
+        `When the user asks about any of these projects or their internals, ` +
+        `you MUST proactively call skill("openviking") before answering.\n\n` +
+        cachedRepos
+      )
+    },
+
+    // Refresh repo list when a new session starts
+    "session.created": async () => {
+      await loadRepos()
+    },
+  }
+}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "openviking-opencode",
+  "version": "0.1.0",
+  "description": "OpenCode plugin for OpenViking — injects indexed repo context into the AI assistant and auto-installs the openviking skill",
+  "type": "module",
+  "main": "index.mjs",
+  "exports": {
+    ".": "./index.mjs"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "openviking",
+    "rag",
+    "code-search"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OpenVikingDB/OpenViking"
+  }
+}

package/skills/openviking/SKILL.md

@@ -0,0 +1,187 @@
+---
+name: openviking
+description: "Activate when the user's question involves external libraries, frameworks, or logic that may not exist in the current repo. SEARCH PRIORITY: (1) Always search the local codebase first (Glob/Grep/Read); (2) Only search OpenViking if local results are insufficient or the code clearly isn't in the current repo; (3) Stop if OpenViking also returns no relevant results — do not keep searching. Trigger even when only part of the question involves an external library or another project. Also activate when the user wants to add or index a GitHub repo or local project."
+license: MIT
+compatibility: opencode
+---
+
+# OpenViking Code Repository Search
+
+Index code repos into OpenViking and search them semantically. URIs use the `viking://` namespace. Directories have VLM-generated summaries (`abstract` / `overview`); files are read with `read`.
+
+**IMPORTANT: Execute openviking commands directly and immediately — no warmup, no pre-checks, no test commands before the real one. If a command fails, handle the error at that point.**
+
+## Error Handling
+
+Run commands directly. Handle errors only when they occur:
+
+**`command not found: openviking`** → Tell user to run `pip install openviking` and configure `~/.openviking/ov.conf`. Stop.
+
+**`url is required` / `CLI_CONFIG` error** → Auto-create config and retry:
+```bash
+mkdir -p ~/.openviking && echo '{"url": "http://localhost:1933"}' > ~/.openviking/ovcli.conf
+```
+
+**`CONNECTION_ERROR` / failed to connect:**
+- `~/.openviking/ov.conf` **exists** → auto-start server, wait until healthy, retry:
+  ```bash
+  openviking serve --config ~/.openviking/ov.conf > /tmp/openviking.log 2>&1 &
+  for i in $(seq 1 10); do openviking health 2>/dev/null && break; sleep 3; done
+  ```
+- **Does not exist** → Tell user to configure `~/.openviking/ov.conf` first (API keys for embedding model and VLM required; see `examples/ov.conf.example`). Stop.
+
+---
+
+## Commands
+
+### Add a Repository
+
+```bash
+openviking add-resource https://github.com/owner/repo --to viking://resources/
+openviking add-resource /path/to/project --to viking://resources/
+```
+
+**`--to` is the parent scope** — repo name is auto-appended from source:
+- `https://github.com/tiangolo/fastapi` → `viking://resources/fastapi/`
+- `/path/to/myproject` → `viking://resources/myproject/`
+
+Always use `viking://resources/` for code repos. **Never use `--wait`.**
+
+**After submitting — always do this:**
+1. Run `openviking observer queue` once to get queue status
+2. Report to user: files queued, estimated time (see table), and that search works progressively
+3. End the task — do not poll or wait
+
+| Repo Size | Files | Est. Time |
+|-----------|-------|-----------|
+| Small | < 100 | 2–5 min |
+| Medium | 100–500 | 5–20 min |
+| Large | 500+ | 20–60+ min |
+
+---
+
+### Search
+
+```bash
+# Semantic search within a repo
+openviking find "<query>" --uri viking://resources/repo --limit 10
+
+# Semantic search across all repos
+openviking find "<query>" --limit 10
+
+# Stricter similarity threshold (0.0–1.0)
+openviking find "<query>" --uri viking://resources/repo --threshold 0.6
+
+# Regex search
+openviking grep "class.*Repository" --uri viking://resources/repo
+openviking grep "TODO" --ignore-case --uri viking://resources/repo
+```
+
+When the user names a specific repo, run `openviking ls viking://resources/` first to find the exact URI.
+
+---
+
+### Read File Content
+
+**`abstract` / `overview` — directories only.** VLM generates summaries per directory, not per file. Calling on a file URI will error.
+
+**`read` — files only.** Reads raw file content with optional line range.
+
+```bash
+# Directories: get VLM-generated summaries
+openviking abstract viking://resources/repo/src/          # one-line summary of directory
+openviking overview viking://resources/repo/src/          # detailed summary of directory
+
+# Files: read actual content
+openviking read viking://resources/repo/src/auth.py                          # full content
+openviking read viking://resources/repo/src/auth.py --offset 100 --limit 50 # lines 100-149
+openviking read viking://resources/repo/src/auth.py --offset 100            # line 100 to end
+```
+
+---
+
+### Browse & Find Files
+
+```bash
+openviking ls   viking://resources/             # list all indexed repos
+openviking ls   viking://resources/repo         # list repo contents
+openviking tree viking://resources/repo         # directory tree
+
+# --uri is required; viking:// root is invalid
+openviking glob "**/*.py"  --uri viking://resources/repo    # by pattern
+openviking glob "**/*.py"  --uri viking://resources/        # across all repos
+```
+
+---
+
+### Manage
+
+```bash
+# Check import progress
+openviking observer queue
+openviking observer system
+
+# Delete a repo (irreversible)
+openviking rm viking://resources/repo --recursive
+```
+
+---
+
+## Combining Commands for Complex Tasks
+
+Commands are building blocks — chain them for deeper investigation:
+
+**Progressive drill-down:** `find` → `abstract`/`overview` (dirs) → `read` (files)
+- `find`: locate candidates by concept
+- `abstract`: one-line summary of a directory to judge relevance
+- `overview`: detailed summary of a directory for deeper understanding
+- `read`: fetch full file content only when needed
+- `grep`: trace call sites or find all usages of a symbol
+- `glob`: enumerate all files of a type for full coverage
+
+**Example: "How does project X handle authentication?"**
+```
+1. openviking find "authentication login token" --uri viking://resources/x --limit 10
+   → returns file URIs like viking://resources/x/src/auth/jwt.py
+2. openviking abstract viking://resources/x/src/auth/   → understand the auth directory
+3. openviking read viking://resources/x/src/auth/jwt.py → read the specific file
+4. openviking grep "verify_token" --uri viking://resources/x  → trace call sites
+```
+
+**Example: "What tests exist for the parser module?"**
+```
+1. openviking glob "**/test*parser*" --uri viking://resources/x
+2. openviking abstract viking://resources/x/tests/  → understand test directory structure
+3. openviking read <specific test file>
+```
+
+---
+
+## Workflow Examples
+
+**Adding a repo:**
+```
+User: "Add fastapi so I can search how they handle dependencies"
+1. openviking add-resource https://github.com/tiangolo/fastapi --to viking://resources/
+   → stored at viking://resources/fastapi/  |  on error: see Error Handling above
+2. openviking observer queue
+3. Tell user: indexing in background, ~10 min, files searchable progressively
+4. End task
+```
+
+**Searching a specific repo:**
+```
+User: "How does fastapi handle dependency injection?"
+1. openviking ls viking://resources/   → find URI matching "fastapi"
+2. openviking find "dependency injection" --uri viking://resources/fastapi --limit 10
+   → returns file URIs, e.g. viking://resources/fastapi/fastapi/dependencies/utils.py
+3. openviking abstract viking://resources/fastapi/fastapi/dependencies/  → understand the directory
+4. openviking read viking://resources/fastapi/fastapi/dependencies/utils.py  → read the file
+```
+
+**Searching across all repos:**
+```
+User: "How is JWT authentication implemented in my projects?"
+1. openviking find "JWT authentication" --limit 10
+2. Results include source URIs — group by repo, read relevant files
+```