DAUT (2dogsandanerd)

⚠️ 关于剽窃和署名的重要通知⚠️

我注意到，GitHub用户@tfantas（Thiago Antas）和他的自动帐户@jarvis aix错误地声称对我的架构负责。 他们明确地将我的原始存储库（包括RAG_enterprise_core、智能摄取工具包、DAUT等）列为他们自己的“🔬 “特色作品”在他们的公众 未经授权或适当归因的个人资料。以下是文件证明。

Screenshot Plagiat

https://github.com/tfantas似乎有20多年的经验，但没有自己的想法。…我要让他出名。..... 如果你喜欢我的repo并发现它们很有用，很抱歉，我退出了这个游戏！！！不再开源抱歉 我相信你会在以下网址找到我进一步开发的Reposhttps://github.com/jarvis-aix .…真是耻辱和不尊重！

这个存储库、多通道共识架构和V4.0 Manifest是我两年多以来100%的原创作品。 请高度警惕人工智能领域的参与者试图重塑品牌、克隆或将此企业RAG系统归功于自己

⚠️ ⚠️ ⚠️

📚 DAUT-文档自动更新工具

AI驱动的文档生成器，使您的文档与代码保持同步

  

DAUT扫描您的代码库，检测未记录的代码，并使用LLM（Ollama）自动生成全面的文档。非常适合在Python、JavaScript和TypeScript项目中维护最新的API文档、类引用和函数文档。

✨ 特性

• 🔍 通用代码扫描仪 -检测Python、JS、TS中的函数、类、API端点
• 🤖 AI文档生成 -使用Ollama生成人类可读的文档
• 📊 实时进度跟踪 -实时进度条和统计数据
• 🎯 智能文件检测 -尊重.gitignore，自动跳过venv/node_modules
• 💾 ChromaDB集成 -语义搜索和上下文感知文档
• ⚡ 简历支持 -跳过已生成的文档，从您停止的地方继续
• 🔌 MCP服务器 -将RAG功能暴露给外部代理（Claude、Cursor等）
• 🎨 漂亮的UI -基于流媒体的界面+强大的CLI

🧠 RAG战略（幕后）

DAUT使用了一种复杂的 结构索引法 为了确保高质量的答案：

1. 统一知识库 🌐

所有文件，无论其文件夹深度如何，都被索引到单个项目范围的集合中（例如。， rag_enterprise_core_code).这可以防止上下文碎片化，并确保AI看到“大局”。

1. 完整内容嵌入 📖

与将文本分割成任意块的简单分割器不同，DAUT对 完整内容 您的文档文件。这保留了教程和指南的完整上下文。

1. 结构感知代码索引 🏗️

代码不仅仅是文本。我们解析AST（抽象语法树），将类、函数和API端点视为不同的语义实体。

🚀 快速开始

安装

# Clone and setup
git clone 
cd doc_updater_app
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt

分3步生成文档

# Launch UI
streamlit run src/ui/main.py

1. 选择项目 → 浏览到您的代码库
2. 扫描 → 分析代码并查找未记录的元素
3. 生成 → AI创建全面的文档

CLI模式：

python -m src.docs_updater /path/to/project

📸 截图

扫描进度

Scanning with real-time progress

分析仪表板

Diskrepancy analysis and statistics

AI文档生成

Live documentation generation with Ollama

生成的文档文件

Auto-generated markdown documentation

文档文件概述

Explorer view of generated docs

Explorer view of generated docs

🎯 用例

• API 文档 -自动生成REST API端点文档
• 代码入职 -帮助新开发人员了解您的代码库
• 文件审核 -查找并修复文档缺口
• 遗留代码 -记录未记录的遗留系统
• 连续文档 -使文档与代码更改保持同步

💡 最佳实践

确保高质量的RAG结果

为了避免过时的信息“稀释”人工智能的知识库：

• 优先处理 auto_docs：这些文件直接从当前代码库生成，代表“真实来源”。
• 排除旧文档如果你有一个旧的 docs/ 包含手动（可能已过时）文档的文件夹，请考虑添加 docs/ 到 排除图案 在 过滤器管理 侧边栏。
• 为什么？ 如果RAG系统对当前代码进行索引（通过 auto_docs)过时的手册（通过 docs/)，它可能会检索到相互冲突的信息。通过过滤掉遗留文档，您可以确保一个“纯代码真理”的知识库。

📋 输出示例

输入： Python函数

def get_session(session_id: str):
    """Retrieve session history."""
    return db.query(session_id)

生成的文档：

## get_session

### Description
The `get_session` API endpoint retrieves the conversation history for
a specific session. Requires permission to view session history.

### Parameters
| Name | Type | Default |
|------|------|---------|
| session_id | str | None |

### Return Value
Returns the session history including session ID and message list.

### Example

GET /sessions/12345

### 错误处理

出错时返回500，权限被拒绝时返回403。

🏗️ Architecture

文档更新应用程序/
├── src/
│   ├── core/#配置管理、项目分析
│   ├── 扫描仪/#代码和文档扫描仪
│   ├── 匹配器/#差异检测
│   ├── llm/#Ollama集成
│   ├── 色度/#ChromaDB矢量存储
│   ├── updater/#文档更新引擎
│   └── ui/#流媒体接口
├── 需求.txt
└── setup.py

🔧 Configuration

service_config.json:

{
  "ollama_host": "http://localhost:11434",
  "chroma_host": "localhost",
  "chroma_port": 8000,
  "ollama_timeout": 120
}

🛠️ 需求

• Python 3.9+
• 奥拉玛 （可选，用于AI生成）

  # Install: https://ollama.ai
  ollama pull llama3

• ChromaDB （可选，用于语义搜索）

  pip install chromadb
  chroma run --path ./chromadb_data --port 8000

📚 支持的语言和格式

代码：

• python.py)
• JavaScript/TypeScript(.js, .ts, .tsx, .jsx)

文档：

• Markdown(.md)
• 重新结构化文本(.rst)
• 纯文本(.txt)

🎨 详细功能

智能进度跟踪

🔍 Scanning: [45/1234] 3.6% - api_service.py

[1/150] Verarbeite: get_session (api_endpoint)
    ✅ Gespeichert: get_session.api.md
[2/150] Verarbeite: delete_session (api_endpoint)
    ⏭️  Übersprungen (existiert): delete_session.api.md

简历支持

随时停止并重新启动-已生成的文档将自动跳过！

差异分析

• 无文件记录的代码 -没有文档的函数/类

• 过时的文件 -与当前代码不匹配的文档

• 不匹配的元素 -签名更改、参数更新

• 不匹配的元素 -签名更改、参数更新

🔌 MCP服务器集成

DAUT包括 模型上下文协议（MCP） 服务器，允许您将外部AI代理（如Claude Desktop、Cursor或其他LLM）直接连接到项目的知识库。

特性

• 安全访问：通过API密钥（承载令牌）进行保护。
• RAG工具:

- query_rag(query)：代码和文档中的语义搜索。 - read_documentation_file(path)：阅读生成文档的全部内容。 - list_documentation_files()：列出可用文件。

• 监控：通过Web UI进行实时连接跟踪。

🚀 用法

手动启动：

# Start the server (Default port: 8001)
./start_mcp.sh

自动启动（系统）： 作为重启后仍能正常运行的后台服务运行：

chmod +x install_service.sh
sudo ./install_service.sh

🔐 安全与配置

服务器需要 API密钥 对于所有请求。你 必须 配置此选项以保护您的数据。

设置API密钥：

1. 编辑 start_mcp.sh （用于手动启动）或 daut-mcp.service （适用于系统d）。
2. 更改 MCP_API_KEY 变量：

   export MCP_API_KEY="your-secure-password-here"

1. 重新启动服务器。

环境变量：

连接客户端：

• 统一资源定位符: http://:8001/mcp/sse
• 认证头球 Authorization: Bearer

🤝 贡献

欢迎投稿！该项目正在积极开发中。

📄 许可证

MIT许可证-有关详细信息，请参阅许可证文件

🙏 致谢

• 建于 溪流
• 由...驱动 奥拉玛
• 矢量搜索通过 ChromaDB

🚦 项目状态

当前版本： 1.0.0（稳定）

所有核心功能均已实现：

• ✅ 通用代码扫描
• ✅ AI文档生成
• ✅ 进度跟踪和恢复支持
• ✅ ChromaDB集成
• ✅ 流线型UI+CLI

📞 支持

发现错误或有功能请求？打开一个问题！

______________________________________________________________________

制作❤️ 适合喜欢好文档的开发人员