Codewiki standalone agent skills

Codewiki gives your current coding agent eight skills for generating, updating, querying, and visualizing source-grounded repository documentation. It uses the agent's existing model session and native file tools. It does not install or start CodeWiki, an MCP server, DeepAgents, or a separate evaluation harness.

Citation & Attribution: CodeWiki is built on and inspired by LangChain's OpenWiki and the repository knowledge concepts of Cognition AI's DeepWiki.

The plugin is named codewiki. Its output uses codewiki/ and CodeWiki 0.6.0's evidence and metadata formats, so existing repository tools can find it. Git and Node.js >=22.22.0 are required for the bundled local helpers; no npm dependencies or API keys are required by the plugin.

Detailed guides, architectural principles, and output specifications are available in the Documentation.

Install

Option A: Direct with npx (No Cloning Required)

From the root of your target project, run:

# Install for all supported agents:
npx @nikhil8bph/codewiki --target all

# Or install for a specific agent (e.g. Antigravity, Cursor, Claude):
npx @nikhil8bph/codewiki --target antigravity

Option B: From Git Repository Clone

Clone this standalone repository:

git clone https://github.com/Nikhil8bph/codewiki.git

From your project repository, run the installer:

node /path/to/codewiki/setup.mjs --target all

Installing for Specific Coding Agents

From your target project repository (or pass --root /path/to/project), run the command for your agent:

| Target Agent | Target Flag | Project Skill Directory | Detection Mechanism | |---|---|---|---| | Google Antigravity | --target antigravity | .agents/skills/ | Automatic project skills discovery | | Claude Code | --target claude | .claude/skills/ | Project skill directory or --plugin-dir | | Cursor | --target cursor | .cursor/skills/ | Project Agent Skills | | Codex | --target codex | .agents/skills/ | Project skill directory or .codex-plugin/ | | OpenCode | --target opencode | .opencode/skills/ | Project skills discovery | | Upstream Pi | --target pi | .agents/skills/ | Shared skills or pi install --local | | Oh My Pi (omp) | --target omp | .omp/skills/ | Project skills directory | | Bob | --target bob | .agents/skills/ | Shared agent skills | | Kiro | --target kiro | .kiro/skills/ | Project skills directory |

1. Google Antigravity

Installs skills into .agents/skills/:

npx @nikhil8bph/codewiki --target antigravity
# Or: node /path/to/codewiki/setup.mjs --target antigravity

Prompt Antigravity:

"Use wiki-init to analyze this codebase and generate repository documentation."

2. Anthropic Claude Code

• Via Skills (Recommended): Installs skills into .claude/skills/:

  npx @nikhil8bph/codewiki --target claude
  # Or: node /path/to/codewiki/setup.mjs --target claude

• Via Native Plugin Flag: Run Claude Code directly with the plugin:

  claude --plugin-dir /path/to/codewiki

Prompt Claude Code:

"Initialize the CodeWiki for this repository using wiki-init."

3. Cursor

Installs skills into .cursor/skills/:

npx @nikhil8bph/codewiki --target cursor
# Or: node /path/to/codewiki/setup.mjs --target cursor

Prompt Cursor (in Agent mode):

"Run wiki-init to build the initial documentation structure."

4. OpenAI / GitHub Codex

• Via Skills: Installs skills into .agents/skills/:

  npx @nikhil8bph/codewiki --target codex
  # Or: node /path/to/codewiki/setup.mjs --target codex

• Via Native Plugin: Uses bundled .codex-plugin/plugin.json. Prompt Codex:

"Use wiki-init to create our repository architecture docs."

5. OpenCode

Installs skills into .opencode/skills/:

npx @nikhil8bph/codewiki --target opencode
# Or: node /path/to/codewiki/setup.mjs --target opencode

Prompt OpenCode:

"Execute wiki-init to generate source-grounded documentation in codewiki/."

6. Upstream Pi

• Via Skills: Installs skills into .agents/skills/:

  npx @nikhil8bph/codewiki --target pi
  # Or: node /path/to/codewiki/setup.mjs --target pi

• Via Native Local Package: In Pi, install directly without copying files:

  pi install --local /path/to/codewiki

  Then reload Pi with /reload and trigger /skill:wiki-init.

7. Oh My Pi (omp)

Installs skills into .omp/skills/:

npx @nikhil8bph/codewiki --target omp

8. Bob

Installs skills into .agents/skills/:

npx @nikhil8bph/codewiki --target bob

9. Kiro

Installs skills into .kiro/skills/:

npx @nikhil8bph/codewiki --target kiro

--target all installs each distinct destination. Identical files are left alone; differing existing skills cause a preflight failure. Review those files before using --force to replace the bundle's files. The installer writes no agent config, MCP config, global home files, or repository instructions. Restart the agent session after installation.

For detailed setup instructions, troubleshooting, and verification, see the Installation Guide.

How to Use (Quick Start Guide)

Once installed, your agent automatically has access to CodeWiki's skills. Here is how to use them:

1. Generating Initial Documentation (wiki-init)

Ask your agent:

"Use wiki-init to inspect this repository, build a documentation plan, and generate our CodeWiki."

The agent will:

1. Explore entry points, tests, package manifests, and core modules.
2. Draft an OKF v0.2 documentation plan in codewiki/.
3. Author markdown pages with source-grounded Mermaid diagrams.
4. Record falsifiable Claims in codewiki/.claims/ and create codewiki/.page-manifest.json.

2. Updating After Code Changes (wiki-update)

After modifying or adding code, ask your agent:

"Run wiki-update to check for source drift and update our documentation."

The agent will inspect git diffs, working-tree changes, and untracked files, identify stale claim bindings, and selectively update only the affected wiki pages.

3. Querying the Wiki (wiki-query)

Ask your agent technical architecture questions:

"Using wiki-query, explain our authentication and token validation flow."

The agent retrieves targeted sections and verifies the underlying code evidence before answering.

4. Interactive Browser Viewer (wiki-visualize)

Ask your agent:

"Use wiki-visualize to build a local viewer for our CodeWiki."

The agent will generate a clean, interactive viewer outside the wiki tree so you can browse pages and render Mermaid diagrams directly in your browser.

Skills Reference

| Skill | Purpose | | ------------------ | ------------------------------------------------------------------------------------ | | wiki-init | Research the repository, author a useful taxonomy, and persist grounded pages. | | wiki-update | Check committed, staged, unstaged, and untracked drift and reconcile affected pages. | | wiki-query | Retrieve only relevant sections and verify consequential details against source. | | claims-grounding | Maintain full Claims sidecars and compute exact evidence/page hashes. | | okf-format | Write OKF v0.2 metadata and deterministic navigation indexes. | | mermaid-diagrams | Author source-grounded diagrams and check available rendering. | | wiki-workspace | Select and maintain related wiki scopes using the existing registry shape. | | wiki-visualize | Build a local viewer outside the generated wiki tree. |

For detailed documentation on each skill, refer to the Skills Reference Guide.

Helpers resolve relative to the installed skill, so the target repository need not contain this plugin checkout or CodeWiki source.

Compatibility and boundaries

The output contract describes codewiki/.claims/, the page manifest, run metadata, and index rendering. The helper preserves exact line endings when hashing and generates canonical repo:// evidence plus codewiki-source- IDs. Standalone provenance identifies codewiki-plugin/0.6.0.

Compatible persisted shapes do not reproduce all native engine guarantees. This plugin has no automatic evidence relocation, native durable page queue, sparse MCP submission, AST repair pipeline, or native source fingerprint. The agent performs source review, reconciliation, navigation, and diagram checks. The helper checks evidence versions and page/manifest binding. Unavailable validators must be reported as unverified, not implied to have passed.

Plugin progress lives in codewiki/.codewiki-run.json, separate from the engine's .run.json. Completed standalone manifest entries omit sourceFingerprint; a later engine run must conservatively recheck coverage. Do not run both generation mechanisms concurrently.

The existing DeepSWE evaluation still generates the treatment wiki through the CodeWiki CLI in an isolated clone. It does not load this plugin. This change does not replace that evaluation path or establish equivalent benchmark results. A future plugin evaluation must retain the same paired tasks/model settings, held-out verifier isolation, and exclusion of wiki/setup files from solution patches.

Source alignment

The paths below refer to the upstream CodeWiki repository, not files required in this standalone checkout.

| Repository source | Plugin contract | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | src/claims/evidence/repository/, src/okf/claim-sources.ts | Canonical URIs, exact version tokens, whole-file source IDs | | src/claims/brains/code/store.ts, src/generation/page-manifest.ts | Sidecar and page binding shapes | | src/okf/, skills/mermaid-diagrams/ | Frontmatter, index layout, source-grounded diagram guidance | | src/integrations/install/registry.ts, docs/pi-integration-notes.md | Host skill paths and the Oh My Pi boundary | | scripts/install-local-integration.mjs | Engine-backed developer installer; intentionally separate from this standalone installer | | scripts/copy-visualize-assets.cjs, src/visualize/ | Engine browser assets; not shipped or assumed by the standalone viewer | | evals/deepswe/ | Existing evaluation and cache constraints, not a plugin benchmark | | codewiki/quickstart.md, codewiki/integrations/coding-agents.md | Navigation context, checked against authoritative source |

Install development dependencies and run the standalone tests from this checkout:

npm install
npm test

Standalone tests require no CodeWiki checkout. Optional upstream parity checks run when CODEWIKI_SOURCE_ROOT points to a CodeWiki 0.6.0 source checkout with its dependencies installed:

# On Linux / macOS / Bash:
export CODEWIKI_SOURCE_ROOT=/path/to/codewiki
npm test

# On Windows PowerShell:
$env:CODEWIKI_SOURCE_ROOT = 'C:/path/to/codewiki'
npm test

Without that variable, source-only comparisons are reported as skipped; installer, page binding, drift, and package checks still run. Installed helpers use only Node built-ins; Vitest is a development dependency.

Citations & Acknowledgments

CodeWiki is built upon and inspired by:

• LangChain's OpenWiki: The open-source repository wiki generator and agent (GitHub: langchain-ai/openwiki).
• Cognition AI's DeepWiki: Research and conceptual foundations for AI repository indexing and deep codebase understanding (deepwiki.com).

License: MIT; see LICENSE.