Synthadoc

Set a wiki as the default so -w is not required for any subsequent command

synthadoc use my-wiki

Installation

Install a wiki and start the engine

A wiki is a self-contained knowledge base — a folder of Markdown pages maintained and cross-referenced automatically by Synthadoc. The fastest way to get started is the History of Computing demo (13 pre-built pages, no LLM API key required to browse).

```bash

1. Pick a template and install

Browse the 30 available templates across 9 categories and pick the one closest to your domain:

synthadoc templates list

Install with a template (example: consumer and competitive market research):

synthadoc install my-market-wiki --target ~/wikis --template research/market-research
synthadoc use my-market-wiki   # set as default — no -w needed from here on

If none of the 30 templates fits, install without one and provide a --domain description instead:

synthadoc install my-wiki --target ~/wikis --domain "Your domain description"

→ Full template catalog and per-category install commands: synthadoc/templates/README.md

Install the demo (includes pre-built pages and raw sources — no LLM call needed)

synthadoc install history-of-computing --target ~/wikis --demo

List all 30 domain templates (and demos) — browse before installing

synthadoc templates list

Install with a domain template — pre-configured guidelines, routing, and starter pages

synthadoc install my-finance-wiki --target ~/wikis --template finance/investment

Sync new source files into an existing demo install (additive only, no overwrites)

synthadoc demo sync history-of-computing

Reinstall the Obsidian plugin into a wiki's vault — normally done automatically by synthadoc install

synthadoc plugin install history-of-computing

Quick-Start Guide

The History of Computing demo includes 13 pre-built pages, raw source files covering clean-merge, contradiction, and orphan scenarios, and a full walkthrough of key Synthadoc feature.

Full step-by-step walkthrough: docs/user-quick-start-guide.md

The guide covers:

1. Verify the demo server started (banner, health check)
2. Install the Synthadoc plugin (auto-installs Dataview) and open the vault
3. Review wiki structure and key files (index, purpose, AGENTS.md, dashboard)
4. Query the pre-built wiki — including knowledge gap detection
5. Batch ingest all demo source files
6. Run lint — auto-promote clean pages to active
7. Manage page lifecycle — 5-state machine (draft → active → stale/contradicted/archived), manual transitions, immutable audit trail
8. Resolve a contradiction
9. Fix an orphan page
10. Run the adversarial lint pass — flag overstated claims across all pages
11. Web search ingestion with automatic decomposition
12. Ingest a YouTube video
13. Enrich the wiki with scaffold (regenerate/update index, purpose, AGENTS.md)
14. Audit features (token cost, history, events)
15. Schedule recurring operations
16. Set up query-scoped routing with ROUTING.md
17. Stage and review candidate pages before promoting them
18. Build a context pack for grounded LLM prompts
19. Verify claim provenance — source-line citations, broken citation audit, global provenance table
20. Export your wiki — llms.txt, llms-full.txt, GraphML wikilink graph, agent-ready JSON with provenance and lifecycle history, OKF v0.1 bundle for zero-code agent consumption
21. Use the web chat UI — streaming answers, session-aware hint chips, citations in-browser
22. Query caching — understand how answers are cached and how to bypass with --no-cache
23. Backup and restore — create a portable wiki zip, restore on a different machine
24. Knowledge graph — weighted edges (wikilink + co-source signals), explore clusters in the web UI Graph tab, click a node to query it
25. Ingest an AI session transcript — turn Claude Code, Codex, or chat conversations into structured wiki pages
26. Agentic maintenance workflows — seven conversational workflows via web UI or CLI: re-ingest stale pages (bulk or by slug), scan and fix broken wikilinks, run lint and view the full report, run scaffold and regenerate wiki files, resolve contradicted pages interactively (diff shown before every write, human approval required), resolve orphaned pages by inserting natural wikilinks into related content, fix broken source citation markers — agent confirms before touching anything, streams inline progress
27. Scan and retract sensitive data — dry-run to surface API keys, emails, SSNs, credit cards, and custom patterns; apply redactions with a single confirmation; incremental --changed-only mode for recurring runs; audit trail records pattern names only (never the values)

---

Command Reference by Use Case

Full CLI command tree (all subcommands, flags, and groupings): docs/design.md — Command tree

List available demo templates

synthadoc demo list

Update existing demo pages from the latest template (overwrites demo pages)

synthadoc demo sync history-of-computing --force

2. Configure your LLM provider and start the server

Open ~/.wikis/my-market-wiki/.synthadoc/config.toml and set your LLM provider, then start:

synthadoc serve
synthadoc status   # should show 0 pages and the scheduled jobs registered

→ Provider list and API key setup: Quick-Start Guide — Appendix C

synthadoc install copies the Synthadoc and Dataview plugins into the vault and pre-enables them. Open the wiki folder in Obsidian — both plugins are active immediately. A local web UI is also available at http://localhost:{port}/app via synthadoc web.

Configuration

You do not need to configure anything to run the demo. The demo wiki ships with its own settings and sensible built-in defaults cover everything else. Set your API key env var, run synthadoc serve, and go.

For the full configuration reference — layer precedence, global vs. per-project config, all keys and defaults — see Appendix E — Configuration in the Quick-Start Guide, or docs/design.md — Configuration for the complete technical reference.

---

Setting up a wiki

```bash

Interfaces & Integration

Set your API keys

At least one LLM API key is required — unless you use Claude Code or Opencode as your provider (no separate API key needed — see Coding tool CLI providers).

Synthadoc defaults to Gemini Flash — free tier, no credit card, 1 million tokens per day. Get a key at aistudio.google.com/app/apikey (click "Create API key").

```bash

Start HTTP API + job worker (foreground — terminal stays attached)

synthadoc serve -w my-wiki

Push the updated plugin binary to every registered wiki after a Synthadoc upgrade

synthadoc plugin upgrade ```