Kizuki

Kizuki is a study tool that runs on your computer. You add course material and teach a concept in your own words. Kizuki plays the student and asks about contradictions, gaps, and unclear words, always quoting your material. These docs describe how it works, generated from the code of the main branch.

• HTTP API: every address the local server at http://127.0.0.1:3700 answers, with methods, parameters, headers, and responses.
• Code reference: every exported function, type, and constant, in the list of modules.
• Guides, in reading order:
  1. Adding material: the formats Kizuki reads and what happens after you upload.
  2. Passages and sentences: how text is split, labeled, checked, and searched.
  3. Teach-back sessions: how Kizuki plays the student and writes its questions.
  4. The model never writes facts: the guards around every use of the model.
  5. When you and the material disagree: corrections, and why yours win.
  6. Nothing is saved without your OK: proposals and confirmations.
  7. Spaced review: when a concept comes back.
  8. Local models and host checks: Ollama, settings, and what keeps other sites out.
  9. Storage and privacy: the data folder and the logs.
  10. How these docs are made: for contributors.

To start Kizuki, see the README.