> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kiwifs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> KiwiFS is a markdown filesystem for agents and teams. Searchable. Structured. Versioned. One binary, zero config.

KiwiFS is a **markdown filesystem for agents and teams** — one Go binary that turns markdown on disk into a searchable, queryable, versioned store accessible via REST, MCP, NFS, S3, WebDAV, and FUSE.

## Why KiwiFS?

Markdown is the lingua franca of agents and developers — but raw `.md` files are just files. No search, no versioning, no structure. KiwiFS layers database-like guarantees on top of plain markdown:

* **Files are the truth** — every page is a plain markdown file with YAML frontmatter. No proprietary format, no lock-in.
* **Agents already know the API** — `cat`, `grep`, `echo` work out of the box. No SDK needed.
* **Every write is a git commit** — full history, blame, diff, and rollback for free.
* **Full-text + vector search** — BM25 via SQLite FTS5 out of the box, with pluggable vector embeddings.
* **Query language (DQL)** — SQL-like queries over frontmatter metadata.
* **Web UI included** — wiki links, knowledge graph, Mermaid diagrams, markdown editing, Bases, canvas, comments, and dark mode.
* **Single binary, zero config** — download and run. No Node, no Docker required (Docker optional).

## How it works

<Mermaid>
  flowchart TD
  subgraph Protocols
  REST\["REST API :3333"]
  NFS\["NFS :2049"]
  S3\["S3 :3334"]
  WebDAV\["WebDAV :3335"]
  FUSE\["FUSE mount"]
  MCP\["MCP stdio/HTTP"]
  end

  REST & NFS & S3 & WebDAV & FUSE & MCP --> Storage

  subgraph KiwiFS\["KiwiFS Server"]
  Storage\["Storage Layer"] --> Git\["Git Commit"]
  Git --> Index\["Search Index"]
  Index --> SSE\["SSE Broadcast"]
  end
</Mermaid>

All protocols flow through the same storage layer. Every write — regardless of how it enters — gets a git commit, a search index update, and an SSE broadcast.

## For AI agents

KiwiFS publishes machine-readable documentation for LLMs and agent frameworks:

* **[llms.txt](/llms.txt)** — concise overview with key endpoints and MCP tool names
* **[llms-full.txt](/llms-full.txt)** — complete API + MCP + CLI reference in a single file

Point your agent at `llms-full.txt` to give it everything it needs to read, write, search, and manage a KiwiFS knowledge base.

## Next steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Install and run KiwiFS in 60 seconds.
  </Card>

  <Card title="Configuration" icon="gear" href="/configuration">
    Configure search, auth, versioning, and more.
  </Card>

  <Card title="Agent Interface" icon="robot" href="/concepts/agent-interface">
    How AI agents read and write markdown.
  </Card>

  <Card title="MCP" icon="plug" href="/concepts/mcp">
    Connect Claude, Cursor, and other AI tools.
  </Card>

  <Card title="Draft spaces" icon="code-branch" href="/concepts/draft-spaces">
    Stage agent edits in git-backed drafts before merge.
  </Card>

  <Card title="Bases (views)" icon="table" href="/concepts/bases-views">
    Saved DQL queries with table and board layouts.
  </Card>

  <Card title="Web UI" icon="window" href="/guides/web-ui">
    Browse, edit, and visualize your knowledge base.
  </Card>

  <Card title="Examples" icon="lightbulb" href="/guides/examples">
    Agent workflows, DQL, import, and deployment recipes.
  </Card>

  <Card title="FAQ" icon="circle-question" href="/guides/faq">
    Common questions about KiwiFS.
  </Card>
</CardGroup>
