kiwifs/kiwifs

Markdown filesystem for agents and teams.

KiwiFS – 面向AI代理和团队的Markdown优先知识库

概述 – 一个单二进制Go服务器,将Markdown文件目录视为实时、可搜索、版本化的知识库。文件是事实的来源;系统添加了Git风格的审计跟踪、全文搜索 + 向量搜索和Web UI,同时通过多种协议(REST、MCP、NFS、S3、WebDAV、FUSE)暴露数据,使得人类和自主代理都能读写。

对AI的重要性 – 现代LLM驱动的代理需要一个地方来持久化上下文,既机器可读(嵌入、结构化前置元数据)又人类可读(Markdown)。KiwiFS允许代理:

  • 通过简单的cat风格命令、HTTP PUT或MCP协议编写Markdown,
  • 使用BM25或语义向量相似度检索相关页面,
  • 使用类似SQL的DQL语言查询结构化元数据,
  • 将每个更改视为Git提交(blame、diff、时间点恢复),
  • 通过Server-Sent Events接收实时更新。

主要功能(如README所列)

功能 您获得的内容
62个MCP工具 适用于Claude、Cursor及任何MCP客户端的原生命令。
嵌入式Web UI 块编辑器、wiki链接反向链接、知识图谱视图、暗黑模式 – 全部通过 go:embed 编译到二进制中。
全文搜索 + 向量搜索 通过SQLite FTS5实现BM25;可插拔的向量后端(OpenAI、Ollama、ONNX、Cohere、Qdrant、pgvector、Pinecone)。
Git版本控制 每次写入都成为原子Git提交;您可以git blame、diff或恢复任何修订版。
DQL(数据查询语言) 对Markdown前置元数据的SQL风格查询(TABLE、WHERE、GROUP BY等)。
六种访问协议 REST、MCP、NFS、S3、WebDAV、FUSE – 全部通过单一存储层路由。
19个导入器 从Postgres、MySQL、MongoDB、Notion、CSV、Obsidian等拉取数据。
内容健康分析 检测过时页面、损坏链接、孤立笔记、矛盾;信任排序搜索。
多空间 托管多个隔离的工作空间,每个都有自己的Git仓库和索引。
Webhooks和模式验证 在写入时触发Slack/CI,对传入的Markdown强制执行JSON模式。
可嵌入的Go库 在您自己的Go应用程序中使用pkg/kiwi。

典型用户

  • 需要代理可以编程方式查询和更新的可写知识库的AI代理开发人员。
  • 寻求自托管、以Markdown为中心的wiki(仍提供现代UI)替代Confluence/Notion的团队。
  • 要求每次更改都有不可变审计跟踪(Git提交)的合规性要求高的组织。
  • 希望代理在事件后自动丰富的runbooks的DevOps / SRE团队。

如何开始(来自README)

# 安装(brew、curl脚本或go install)
brew install kiwifs/tap/kiwifs
# 或
curl -fsSL https://raw.githubusercontent.com/kiwifs/kiwifs/main/install.sh | sh
# 或
go install github.com/kiwifs/kiwifs@latest

# 初始化工作空间
kiwifs init --template knowledge --root ./knowledge

# 运行服务器(REST API在:3333,UI在http://localhost:3333)
kiwifs serve --root ./knowledge

Docker替代方案:

docker run -p 3333:3333 -v ./knowledge:/data ameliaanhlam/kiwifs

代理可以通过简单的HTTP请求写入:

curl -X PUT 'localhost:3333/api/kiwi/file?path=pages/auth.md' \
  -H "X-Actor: my-agent" \
  -d "# Authentication\n\nOAuth2 + JWT..."

架构概览(来自README的文本图)

  • 单个Go二进制嵌入Web UI(shadcn/ui、CodeMirror、Sigma.js)。
  • 访问层暴露REST、MCP、NFS、S3、WebDAV、FUSE。
  • 核心处理存储、Git版本控制、SQLite FTS5、可选的向量存储、文件观察器、SSE事件、模式检查。
  • 文件系统后端包括本地磁盘、NFS、EFS、JuiceFS、FUSE-S3。

可扩展性

  • 通过config.toml中的[search.vector]可插拔向量提供者(OpenAI、Ollama、ONNX等)。
  • 添加自定义导入器或导出管道(带嵌入的JSONL/CSV)。
  • 在其他程序中直接使用Go库。

许可证 – Business Source License 1.1(自托管使用免费;商业SaaS产品需要单独许可证)。每个版本四年后重新许可为Apache 2.0。

了解更多 – 文档站点(https://docs.kiwifs.com)、API规范、示例、FAQ、路线图和架构文档都已从README链接。


以上所有信息均直接取自仓库的README;没有推断其他功能。

相关

  • 项目
  • 项目
  • 项目
  • 项目