简体中文 | English

Unlock your codebase with AI, all locally, with your privacy intact.xs

Lost in a code maze? Tired of tedious context prep for AI collaboration? Folda-Scan to the rescue! 💡

Folda-Scan is a revolutionary intelligent project Q&A tool that runs entirely locally in your browser. It transforms your codebase into a conversational partner using advanced semantic vectorization, making code comprehension and AI collaboration unprecedentedly simple and secure.

Folda-Scan (as part of the WebFS-Toolkit) is built with cutting-edge web technologies and AI algorithms to offer you a smooth, efficient, and secure local code interaction experience.

• 🛡️ Absolute Privacy, Local Execution: All data processing happens locally in your browser; your code never leaves your machine.
• 💬 "Chat" with Code in Natural Language: Ask questions about your codebase as if talking to a colleague and get precise answers.
• 🧠 Deep Semantic Understanding: Goes beyond keywords to grasp the true intent and complex logic within your code.
• 🎯 Pinpoint Information Instantly: Quickly locate relevant code snippets and files, even with vague descriptions.
• 🤖 LLM Collaboration Accelerator: Generate context-aware Markdown with one click, perfectly "feeding" AI assistants (ChatGPT, Claude, etc.).
• 💰 Slash Token Costs: Optimize LLM interactions, significantly reducing API call expenses and latency.
• 🛠️ Smart Config Generation: Assists in creating project configuration files like Dockerfile.
• 🚀 Instant Onboarding: Clear guidance to kickstart your code exploration journey quickly.

Folda-Scan's magic comes from its innovative semantic vectorization engine:

1. Local Scanning & Indexing: Securely scans your selected local project, converting code into high-dimensional vectors via semantic analysis, building a knowledge index locally in your browser.
2. Intelligent Natural Language Processing (NLP): Understands your natural language questions and converts them into vectors too.
3. Precise Semantic Matching: Efficiently matches question vectors with code content in the vector space to provide the most relevant answers. All done efficiently in your browser, with your data privacy fully protected.

• Core Framework: Next.js 14
• Local File Interaction: File System Access API
• AI & NLP: Advanced Semantic Vector Analysis, Natural Language Processing Algorithms
• Main Language: [JavaScript/TypeScript - please specify]

  🏁 Getting Started

• Node.js (Recommended v16+ or v18+, refer to package.json)
• npm (Version per package.json, e.g., npm@10.x.x) / yarn / pnpm
• A modern browser supporting File System Access API (e.g., latest Chrome, Edge)

1. Select Folder: Authorize browser access to your local code project.
2. Wait for Indexing: Folda-Scan will quickly build a semantic index locally.
3. Start Asking: Query your codebase in natural language and unveil its secrets!

We enthusiastically welcome contributions of all kinds! Whether it's bug reports, feature suggestions, or code submissions, please refer to our Contribution Guidelines (if you have one). Let's build a better Folda-Scan together!

This project is licensed under the MIT License.

Back to Top

代码迷宫中找不到方向？与 AI 协作时上下文准备太繁琐？ Folda-Scan 来拯救您！ 💡

Folda-Scan 是一款革命性的智能项目问答工具，它完全在您的浏览器本地运行，通过先进的语义向量化技术，将您的代码库转化为可对话的智能伙伴。告别繁琐，拥抱高效，让代码理解和 AI 协作变得前所未有地简单和安全。

Folda-Scan (作为 WebFS-Toolkit 的一部分) 采用尖端 Web 技术和 AI 算法，为您带来流畅、高效且安全的本地代码交互新体验。

• 🛡️ 绝对隐私，本地运行：所有数据处理均在浏览器本地完成，代码永不离开您的计算机。
• 💬 自然语言“聊”代码：像和同事聊天一样向代码库提问，精准获取答案。
• 🧠 深层语义理解：超越关键词，理解代码的真实意图和复杂逻辑。
• 🎯 信息秒级定位：模糊描述也能快速定位相关代码片段和文件。
• 🤖 LLM 协作加速器：一键生成上下文感知的 Markdown，为 AI 助手（ChatGPT, Claude 等）提供完美“食粮”。
• 💰 Token 成本骤降：优化 LLM 交互，显著降低 API 调用成本和等待时间。
• 🛠️ 智能配置生成：辅助生成 Dockerfile 等项目配置文件。
• 🚀 即时上手：清晰的项目运行指导，快速启动您的代码探索之旅。

Folda-Scan 的魔法源于其创新的语义向量化引擎：

1. 本地扫描与索引：安全扫描您选定的本地项目，通过语义分析将代码转化为高维向量，在浏览器本地构建知识索引。
2. 智能自然语言处理 (NLP)：理解您的自然语言提问，并将其同样向量化。
3. 精准语义匹配：在向量空间中高效匹配问题与代码内容，提供最相关的答案。 这一切都在保障您数据隐私的前提下，在浏览器中高效完成。

• 核心框架: Next.js 14
• 本地文件交互: File System Access API
• AI & NLP: 先进语义向量分析、自然语言处理算法
• 主要语言: [JavaScript/TypeScript - 请指明]

  🏁 快速开始 (Getting Started)

• Node.js (建议 v16+ 或 v18+, 参照 package.json)
• npm (版本参照 package.json, 例如 npm@10.x.x) / yarn / pnpm
• 支持 File System Access API 的现代浏览器 (如 Chrome, Edge 最新版)

1. 选择文件夹：授权浏览器访问您的本地代码项目。
2. 等待索引：Folda-Scan 将在本地快速构建语义索引。
3. 开始提问：用自然语言向您的代码库提问，探索其奥秘！

我们热烈欢迎各种形式的贡献！无论是 Bug 报告、功能建议还是代码提交，请参考我们的 贡献指南 (如果您有的话)。期待与您共建更好的 Folda-Scan！

本项目基于 MIT 许可证 开源。

返回顶部 (Back to Top)