Skip to main content
OpenWiki can run inside an existing coding agent instead of launching its own model. The coding agent investigates the repository, plans the wiki, and writes each assigned page with its native repository tools. OpenWiki owns the durable page-job lifecycle, Claims validation and persistence, source-drift handling, and deterministic finalization. Host-driven runs support only repository code mode wikis, not personal mode. They use the coding agent’s authenticated model session, so OpenWiki provider credentials are not required. Connector-sourced context, including LangSmith, is not yet supported on this path. Host-driven page authoring is sequential; parallel page workers apply to the native CLI only.

Install an integration

Supported hosts are Codex, Claude Code, GitHub Copilot, OpenCode, Cursor, IBM Bob (Bob Shell), Kiro, Oh My Pi (omp), and Antigravity CLI. Installations default to user level, so one install works from any Git repository:
Restart the coding agent after installation. Then open the repository and ask:
For an existing wiki, ask:
Installed integrations also expose search and read tools so the host can query an existing wiki without starting a generation run.

Inspect or uninstall

Add --project [path] to list, install, or uninstall for repository-scoped state. Project paths resolve to the Git repository root. Host-specific user-level locations:
  • OpenCode: ~/.config/opencode
  • IBM Bob / Bob Shell: ~/.agents/skills and ~/.bob/settings/mcp.json (project scope uses .agents/skills and .bob/mcp.json)
  • Kiro: ~/.kiro/skills and ~/.kiro/settings/mcp.json
  • Oh My Pi: ~/.omp/agent for the default profile. Use --project for named profiles or a relocated PI_CODING_AGENT_DIR
  • Antigravity CLI: ~/.gemini/antigravity-cli/skills and ~/.gemini/config/mcp_config.json

Pi package

Pi loads OpenWiki’s skill, retrieval, and lifecycle tools from the npm package:
Use pi install --local npm:openwiki for a project-local install. The Pi extension starts OpenWiki’s CLI through Node, so openwiki need not be on PATH. Pi is not a target of openwiki integrations install.

How host-driven runs work

Host-driven runs follow the same resumable page-job lifecycle as native openwiki --init and openwiki --update. The coding agent drives repository research and page authoring; OpenWiki validates each completion, persists Grounded Claims, and finalizes metadata through MCP. On each page, the host submits sparse Claim decisions (confirm, revise, add, or retract). OpenWiki retains unaffected Claims, applies the explicit decisions, and refuses to finish until the final Claims state is durable. The host can call openwiki_inspect_page_claims when it needs the complete Claims set for the current page.

Defer unplanned Claim issues

deferUnplannedClaimIssues requires OpenWiki v0.9.0 or later.
By default, openwiki_submit_plan on an update run automatically adds page jobs for every existing page that has stale or unresolved Claims, even when the host did not include those pages in its plan. To run a focused update that touches only the pages the host explicitly planned, set deferUnplannedClaimIssues to true in the openwiki_submit_plan input:
  • deferUnplannedClaimIssues (optional boolean, default false): When true, OpenWiki skips inserting automatic jobs for unplanned pages with Claim issues. Those pages are recorded as deferred, and the run finishes in an interrupted state until a future full update reconciles them. When true, OpenWiki skips inserting automatic jobs for unplanned pages with Claim issues. Those pages are left untouched, and the run completes but records its update metadata as interrupted until a future full update reconciles them. This option is valid only on update runs. Setting it on an init run returns an invalid_input error.

See also