Using the llmwiki SDK for Programmatic Wiki Control

npm install llm-wiki-compiler

import { createWiki } from "llm-wiki-compiler";

import { createWiki } from "llm-wiki-compiler";

const wiki = createWiki({ root: "./my-wiki" });

import { createWiki } from "llm-wiki-compiler";

const wiki = createWiki({ root: "./my-wiki" });

// Ingest raw text safely (no network fetch)
await wiki.ingestText({ title: "Notes", text: "Raw text to compile..." });

// Compile pending sources into wiki pages (requires LLM credentials)
await wiki.compile();

// Ask a question and get a grounded answer
const { answer } = await wiki.query("What did I note about X?");
console.log(answer);

// Read a read-only status snapshot - no credentials needed
const status = await wiki.status();
console.log(`${status.pages.total} pages, ${status.sources} sources`);

import { startViewer } from "llm-wiki-compiler";

const viewer = await startViewer({
  root: "/absolute/path/to/my-wiki",
  host: "127.0.0.1",
  port: 0,
  sourceChanges: true,
});
console.log(`http://127.0.0.1:${viewer.port}/#/source-changes`);

import { createWiki, type RecordIntentV1 } from "llm-wiki-compiler";

// The trusted application host chooses this identity and grant, not a model.
async function prepareForReview(root: string, intent: RecordIntentV1) {
  const wiki = createWiki({
    root,
    operations: {
      id: "process-coordinator",
      grants: ["operation-bundle.prepare"],
    },
  });
  // The caller must handle prepared, refused and unavailable results.
  // A prepared reference is neither approval nor proof of application.
  return wiki.operations.prepareRecord(intent);
}

llmwiki operation inspect <digest>
llmwiki product apply <digest>

const { ref } = await wiki.writeArtifact({
  artifactType: "edition-assets", // declared by the active profile
  slug: "issue-01",
  memberFiles: [{ fileName: "cover.jpg", bytes: jpegBytes }],
});

const result = await wiki.query("How does attention work?");
if (!result.answerCitations) {
  console.log("Answer citations: unavailable");
} else {
  for (const citation of result.answerCitations.citations) {
    if (citation.status === "resolved") console.log(citation.target, citation.pageId);
    else if (citation.status === "pending") console.log(citation.target, citation.candidateIds);
    else console.log("Broken target:", citation.target);
  }
}

const result = await wiki.query("How does attention work?", { save: true, review: true });
if (result.publicationRefusal) {
  console.log(result.answer, result.publicationRefusal);
} else if (result.candidateId) {
  console.log("Review candidate:", result.candidateId);
} else if (result.saved) {
  console.log("Published query:", result.saved);
}

import { createWiki, ProviderUnavailableError, UnknownProviderError } from "llm-wiki-compiler";

const wiki = createWiki({ root: "./my-wiki" });

try {
  await wiki.compile();
} catch (err) {
  if (err instanceof ProviderUnavailableError) {
    console.error("No LLM provider configured - set ANTHROPIC_API_KEY or equivalent.");
  } else if (err instanceof UnknownProviderError) {
    console.error("LLMWIKI_PROVIDER is set to an unrecognized value.");
  } else {
    throw err;
  }
}

import type {
  CompileResult,
  IngestResult,
  QueryResult,
  WikiStatus,
  ContextPack,
  EvalReport,
  OkfExportReport,
  OkfImportReport,
} from "llm-wiki-compiler";