Mithril — Documentation

Modules

11

documented with HTML + README

Architecture

getting-started.html

overview & quick start

Module Documentation

Each source module has a README.html (interactive) and README.md (for GitHub/IDE). Click to open:

Providers — The Five Wizards

LLM API adapters (Gemini, OpenAI, Anthropic, Groq, Local)

src/providers/README.html

Flow — Orchestration Council

Multi-agent routing, GGUF classifier, NEXT/TASK protocol

src/flow/README.html

Tools — The Armory

24 executable tools (file, git, web, code, terminal)

src/tools/README.html

API — Beacon Towers

Ollama + OpenAI + MCP HTTP server

src/api/README.html

Engine — Khazad-dûm

Local GGUF inference, Metal GPU, token streaming

src/engine/README.html

Operators — Rangers

Secure I/O: sandboxed terminal, path protection, shadow undo

src/operators/README.html

CLI — Fellowship's Voice

REPL + centralized commands via ChatCore

src/cli/README.html

TUI — Minas Tirith

Full-screen interface with popups and panels

src/tui/README.html

Config — The Vaults

Argon2id encryption, env var fallback, permissions

src/config/README.html

Session — Chronicles

Persistent conversations, multi-frontend handoff

src/session/README.html

Index — The Palantír

BM25 search for context injection

src/index/README.html

Other Resources

Getting Started & Architecture Guide
README.md — Project overview
CONTRIBUTING.md — How to contribute
Dockerfile — Docker deployment