packages/plugins/plugin-llm-wiki/README.md
Local-file LLM Wiki plugin for source ingestion, wiki browsing, query, lint, and maintenance workflows.
This package is the standalone home for LLM Wiki behavior. Wiki-specific routes, UI, prompts, tools, local-folder templates, migrations, fixtures, and tests live here rather than in Paperclip core.
The alpha surface includes:
raw/, wiki/, AGENTS.md, IDEA.md, wiki/index.md, and wiki/log.mdWiki Maintainer agent, managed LLM Wiki project, and paused managed routines for wiki update processing, lint, and index refreshsurfaceVisibility: "plugin_operation"raw/ with metadata rows in the plugin DB namespacedistill-now, backfill) always writes into the default wiki space in Phase 1; non-default spaces remain on manual / raw-file ingest until per-space Paperclip ingestion profiles shipwiki/projects/<slug>/standup.md as the executive current-state view for each represented project, alongside durable wiki/projects/<slug>/index.md knowledge pagesPaperclip-derived text ingestion stays limited to issue titles/descriptions, issue comments, and issue documents.
/api/assets/:id/content, dereference work-product url fields, or store those capability-bearing links in source bundles/snapshots.The accepted policy lives in doc/plans/2026-05-06-llm-wiki-paperclip-asset-security-gate.md.
pnpm install
pnpm dev # watch builds
pnpm dev:ui # local dev server with hot-reload events
pnpm test
From the Paperclip repo root:
pnpm --filter @paperclipai/plugin-llm-wiki typecheck
pnpm --filter @paperclipai/plugin-llm-wiki test
pnpm --filter @paperclipai/plugin-llm-wiki build
Run these commands from the Paperclip repo root before handing off alpha plugin changes:
pnpm --filter @paperclipai/plugin-llm-wiki typecheck
pnpm --filter @paperclipai/plugin-llm-wiki test
pnpm --filter @paperclipai/plugin-llm-wiki build
The focused Vitest suite covers:
Remaining alpha gaps:
tests/screenshots;
generated screenshots/ outputs are local artifacts and are ignored by git.curl -X POST http://127.0.0.1:3100/api/plugins/install \
-H "Content-Type: application/json" \
-d '{"packageName":"/Users/dotta/paperclip/.paperclip/worktrees/PAP-3179-design-a-llm-wiki-plugin/packages/plugins/plugin-llm-wiki","isLocalPath":true}'
pnpm build uses esbuild presets from @paperclipai/plugin-sdk/bundlers.pnpm build:rollup uses rollup presets from the same SDK.After changing manifest-loaded assets such as skills, agent instructions, or templates, recompile the local plugin before re-enabling it:
pnpm --filter @paperclipai/plugin-llm-wiki build
The package-local dist/ directory is ignored by git, but local Paperclip
installs load the compiled dist/manifest.js and dist/worker.js files at
runtime. If activation failed before the rebuild, re-enable the plugin or
restart the Paperclip dev server so the host imports the fresh bundle.
<configured-wiki-root>/
AGENTS.md
IDEA.md
.gitignore
raw/
.gitkeep
wiki/
index.md
log.md
sources/
.gitkeep
projects/
.gitkeep
<project-slug>/
index.md
standup.md
decisions.md
history.md
entities/
.gitkeep
concepts/
.gitkeep
synthesis/
.gitkeep
Use the settings page or bootstrap-root action to configure the folder and
write the starter files. The plugin uses Paperclip's local folder API for path
containment, symlink checks, read/write validation, and atomic writes.
Bootstrap preserves existing files rather than overwriting operator edits. The
default first-install skeleton is copied from the vanilla LLM Wiki layout, with
CLAUDE.md renamed to AGENTS.md and Paperclip project overviews, standups,
decisions, and history kept together under wiki/projects/<slug>/.
Plugin-managed agent instruction bundles live under:
agents/<agent-key>/AGENTS.md
For this plugin the Wiki Maintainer source bundle is agents/wiki-maintainer/AGENTS.md.
Any additional files in that folder are installed as sibling instruction files
for the managed agent. The settings health check reports drift from these
defaults, and resetting the managed agent asks for confirmation before replacing
customized instructions.