Skip to content
Registry

openwiki

v0.1.16

Source-grounded markdown wiki for any git repository — openwiki::* functions generate, search, and incrementally refresh categorized pages with pinned-commit line citations, and the engine serves a browser UI + JSON API under /openwiki.

license: Apache-2.0docsdocumentationknowledge-basemarkdownrepowiki

Install

bash
iii trigger compose::add worker=openwiki

Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.

Functions42

openwiki::ask

Function

Ask a question about a wiki; returns a cited answer. mode=fast (router) or deep (harness).

Request
  • file_answerboolean

    File a good answer back into the wiki as a new page.

  • idstringrequired
  • modestringenum fast, deep

    fast = router retrieval; deep = harness multi-hop.

  • qstringrequired
Response
  • answerstringrequired
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
    • urlstring
  • filed_slugstring

openwiki::ask-question

Function

MCP: ask a question about a wiki; returns a cited answer.

Request
  • idstringrequired
  • qstringrequired
Response
  • answerstringrequired
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
    • urlstring
  • filed_slugstring

openwiki::cron::refresh-due

Function

Cron: refresh every wiki whose auto-refresh interval has elapsed.

Request
Empty object
Response
  • refreshedintegerrequired

openwiki::delete

Function

Delete a wiki and all its pages. Params: { id }.

Request
  • idstringrequired
Response
  • deletedbooleanrequired
  • idstringrequired

openwiki::diagram

Function

Generate a Mermaid diagram (architecture|dataflow|deps) of a wiki.

Request
  • idstringrequired
  • kindstringenum architecture, dataflow, deps
Response
  • kindstring
  • mermaidstringrequired

openwiki::export-agents-md

Function

Build the AGENTS.md/CLAUDE.md pointer block for a wiki.

Request
  • base_urlstring
  • idstringrequired
  • targetsstring[]enum AGENTS.md, CLAUDE.md
Response
  • contentstringrequired
  • targetsstring[]

openwiki::gen-stats

Function

Report the source bytes read and page bytes written for one wiki generation.

Request
  • idstringrequired
Response
  • output_bytesinteger
  • page_countinteger

openwiki::generate

Function

Start generating a source-grounded wiki for a git repository URL. Returns immediately with { wiki_id, status }; poll openwiki::status.

Request
  • modelstring

    Optional LLM model id, routed via llm-router.

  • refstring

    Optional branch/tag/commit to check out (default: default branch).

  • repo_urlstringrequired

    HTTPS git URL of a public repository.

  • steerobject

    Optional per-repo steering (repo_notes, explicit pages, caps). Mirrors openwiki.json.

Response
  • statusstringrequired
  • wiki_idstringrequired

openwiki::http::ask

Function

HTTP POST /openwiki/api/wikis/:id/ask

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::diagram

Function

HTTP GET /openwiki/api/wikis/:id/diagram

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::events

Function

HTTP GET /openwiki/api/wikis/:id/events (SSE live progress)

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::models

Function

HTTP GET /openwiki/api/models

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::page-get

Function

HTTP GET /openwiki/api/wikis/:id/pages/:slug

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::pages-list

Function

HTTP GET /openwiki/api/wikis/:id/pages

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::refresh

Function

HTTP POST /openwiki/api/wikis/:id/refresh

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::schedule-set

Function

HTTP PUT /openwiki/api/wikis/:id/schedule

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::search

Function

HTTP GET /openwiki/api/wikis/:id/search?q=

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::ui

Function

HTTP: serve the OpenWiki browser UI.

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wiki-delete

Function

HTTP DELETE /openwiki/api/wikis/:id

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wiki-get

Function

HTTP GET /openwiki/api/wikis/:id

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wiki-status

Function

HTTP GET /openwiki/api/wikis/:id/status

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wikis-create

Function

HTTP POST /openwiki/api/wikis

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::http::wikis-list

Function

HTTP GET /openwiki/api/wikis

Request
  • bodystring
  • headersobject
  • methodstring
  • path_paramsobject
  • query_paramsobject
Response
  • bodystringrequired
  • headersobject
  • status_codeintegerrequired

openwiki::lint

Function

Validate every page citation against the clone and flag thin pages.

Request
  • idstringrequired
Response
  • checkedintegerrequired
  • issuesobject[]required
    • detailstring
    • kindstringrequiredenum broken-citation, orphan, missing-xref, stale, thin
    • slugstringrequired

openwiki::models

Function

List the models available for wiki generation, plus the configured default. Empty when no provider is configured.

Request
Empty object
Response
  • default_modelstringrequired
  • modelsobject[]required
    • idstringrequired
    • providerstringrequired
    • supports_structured_outputboolean

openwiki::on-config-change

Function

Reload runtime config when the openwiki configuration entry changes.

Request
Empty object
Response
  • reloadedbooleanrequired

openwiki::on-turn-completed

Function

Internal: routes harness::turn-completed events to the active generation.

Request
Empty object
Response
valuenull

openwiki::on-turn-started

Function

Internal: routes harness::turn-started events (sub-agent spawns) to the active generation.

Request
Empty object
Response
valuenull

openwiki::page

Function

Get a single wiki page (markdown body + metadata). Params: { id, slug } (slug from openwiki::pages).

Request
  • idstringrequired
  • slugstringrequired
Response
  • categorystring
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
    • urlstring
  • confidencestringenum low, medium, high
  • generatorstringenum harness, router, heuristic
  • last_updatedstring
  • markdownstringrequired
  • quality_issuesinteger
  • slugstringrequired
  • source_pathsstring[]
  • statusstringenum current, needs-review, stale
  • titlestring

openwiki::pages

Function

List all pages of a wiki. Params: { id }.

Request
  • idstringrequired
Response
  • pagesobject[]required
    • categorystringrequired
    • citationsobject[]
      • end_lineinteger
      • notestring
      • pathstringrequired
      • start_lineinteger
      • urlstring
    • confidencestringenum low, medium, high
    • generatorstringenum harness, router, heuristic
    • last_updatedstring
    • quality_issuesinteger
    • slugstringrequired
    • source_pathsstring[]
    • statusstringenum current, needs-review, stale
    • titlestringrequired

openwiki::read-wiki-contents

Function

MCP: read one wiki page (markdown + metadata).

Request
  • idstringrequired
  • slugstringrequired
Response
  • categorystring
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
    • urlstring
  • confidencestringenum low, medium, high
  • generatorstringenum harness, router, heuristic
  • last_updatedstring
  • markdownstringrequired
  • quality_issuesinteger
  • slugstringrequired
  • source_pathsstring[]
  • statusstringenum current, needs-review, stale
  • titlestring

openwiki::read-wiki-structure

Function

MCP: list a wiki's structure (categories + pages).

Request
  • idstringrequired
Response
  • categoriesobject[]
    • descriptionstring
    • idstringrequired
    • titlestring
  • pagesobject[]required
    • categorystring
    • slugstringrequired
    • titlestring
  • repostring
  • summarystring

openwiki::refresh

Function

Pull the repo and regenerate only the pages whose source changed (incremental).

Request
  • idstringrequired
Response
  • changedobject[]
    • pathstringrequired
    • statusstringrequired
  • pages_affectedstring[]
  • refreshstringrequiredenum regenerating, up_to_date, in_progress, error
  • wiki_idstringrequired

openwiki::search

Function

Search pages of a wiki by keyword. Params: { id, q }.

Request
  • idstringrequired
  • qstringrequired
Response
  • resultsobject[]required
    • categorystring
    • matchedstring[]
    • scorenumberrequired
    • slugstringrequired
    • snippetstring
    • source_pathsstring[]
    • titlestring

openwiki::set-schedule

Function

Set a wiki auto-refresh cadence: off | 3h | 6h | 12h | daily | weekly | a cron string. Params: { id, schedule }.

Request
  • idstringrequired
  • schedulestringrequired
Response
  • idstringrequired
  • okbooleanrequired
  • schedulestringrequired

openwiki::src::grep

Function

Search file contents in a wiki's cloned repo. Params: { id, pattern, max? }.

Request
  • idstringrequired
  • maxinteger
  • patternstringrequired
Response
  • matchesobject[]required
    • lineintegerrequired
    • pathstringrequired
    • textstringrequired
  • truncatedboolean

openwiki::src::list

Function

List files (path, language, priority) in a wiki's cloned repo. Params: { id, dir? }.

Request
  • dirstring
  • idstringrequired
Response
  • filesobject[]required
    • languagestring
    • pathstringrequired
    • priorityinteger
    • sizeinteger
  • truncatedboolean

openwiki::src::read

Function

Read a file (optional 1-indexed line window) from a wiki's cloned repo. Params: { id, path, from?, to? }.

Request
  • frominteger
  • idstringrequired
  • pathstringrequired
  • tointeger
Response
  • contentstringrequired
  • frominteger
  • pathstringrequired
  • tointeger
  • total_linesinteger
  • truncatedboolean

openwiki::status

Function

Check the generation status and progress of a wiki.

Request
  • idstringrequired
Response
  • errorstring
  • messagestring
  • phasestringrequiredenum queued, cloning, inventorying, planning, generating, linting, …
  • progressnumberrequired
  • updated_atstring

openwiki::wiki

Function

Fetch a single wiki's metadata.

Request
  • idstringrequired
Response
  • categoriesobject[]
    • descriptionstring
    • idstringrequired
    • titlestringrequired
  • category_countintegerrequired
  • commitstring
  • content_hashstring
  • created_atstring
  • generatingbooleanrequired
  • idstringrequired
  • last_refresh_atstring
  • modelstring
  • navigationobject[]
    Empty object
  • page_countintegerrequired
  • refstring
  • refresh_schedulestring
  • repo_namestringrequired
  • repo_urlstringrequired
  • steerobject
  • summarystring
  • updated_atstring

openwiki::wikis

Function

List all wikis generated by this worker.

Request
Empty object
Response
  • wikisobject[]required
    • categoriesobject[]
      • descriptionstring
      • idstringrequired
      • titlestringrequired
    • category_countintegerrequired
    • commitstring
    • content_hashstring
    • created_atstring
    • generatingbooleanrequired
    • idstringrequired
    • last_refresh_atstring
    • modelstring
    • navigationobject[]
      Empty object
    • page_countintegerrequired
    • refstring
    • refresh_schedulestring
    • repo_namestringrequired
    • repo_urlstringrequired
    • steerobject
    • summarystring
    • updated_atstring

openwiki::write-page

Function

Store a finished wiki page (markdown + metadata) from a page-writer sub-agent.

Request
  • categorystring
  • citationsobject[]
    • end_lineinteger
    • notestring
    • pathstringrequired
    • start_lineinteger
  • idstringrequired
  • markdownstringrequired
  • slugstringrequired
  • source_pathsstring[]
  • titlestring
Response
  • okbooleanrequired
  • slugstringrequired

Triggers0

No triggers registered

Search the registry

Find workers, kits and executables, or jump to a page.