harshitkrhere/WinterSolve

# WinterSolve WinterSolve 是一款开源的开发者操作系统（Developer OS），专为希望更快地理解、改进、调试、记录和维护软件项目的编码人员而设计。 它基于 **Repo Brain** 构建，这是一个离线优先的项目智能层，可以将代码仓库转化为架构笔记、风险信号、命令猜测、安全检查、文档健康状况和下一步行动，而无需 AI 账户。 ## 概述 WinterSolve 是一款离线优先的命令行产品，可帮助开发者检查代码仓库、理解文件、分析错误、改进文档、准备代码审查，并建立项目的实用心智模型。 ## WinterSolve 为何存在 开发者不仅需要聊天机器人。他们需要可重用的工作流，将重复的工程痛点转化为可靠的工具。 WinterSolve 专注于每天出现的开发者问题： - 理解不熟悉的代码库 - 调试错误和堆栈跟踪 - 生成有用的文档 - 创建项目模板 - 审查代码变更 - 编写测试 - 解释 API 和架构 - 自动化重复的设置和维护工作 - 将项目知识转化为可重用的 AI 工作流 ## WinterSolve 的与众不同之处 WinterSolve 旨在通过以下几个重要方式在典型的 AI 编码项目中脱颖而出： - **工作流优先，而非提示词优先**：每个功能都应解决可重复的开发者问题，而不仅仅是提供一个空白的聊天框。 - **开放且可扩展**：贡献者可以将工具、适配器、提示词、模板和集成作为独立模块添加。 - **开发者拥有的 AI**：随着时间推移，该项目应支持多个模型提供商和本地选项。 - **设计上具备代码库感知能力**：WinterSolve 应与代码仓库结构、文档、测试、issue 和项目约定协同工作。 - **实用输出**：生成的结果应转化为开发者实际可用的文件、补丁、报告、清单或命令。 - **对初学者友好，对资深者有用**：新手开发者获得指导，而经验丰富的开发者获得自动化和可重复的工作流。 - **注重隐私的路径**：敏感代码应被谨慎处理，未来将支持本地执行和可配置的数据共享。 ## 核心工具包领域 ## 功能 - 代码仓库健康扫描 - Repo Brain 项目智能报告 - 离线文件解释 - 错误和堆栈跟踪分析 - 文档改进建议 - 本地变更审查清单 - 安全和隐私检查 - 用于未来集成的稳定 JSON 输出 - 用于未来 AI 驱动工作流的开放模块结构 ### 1. 代码理解 帮助开发者快速理解代码库的工具： - 项目地图生成器 - 文件和依赖解释器 - 架构摘要 - API 路由浏览器 - 新人入职指南生成器 ### 2. 调试助手 帮助诊断和修复错误的工具： - 堆栈跟踪解释器 - 错误修复建议 - 日志摘要工具 - 失败测试分析器 - 依赖和环境检查器 ### 3. 文档自动化 将项目知识转化为实用文档的工具： - README 生成器 - API 文档助手 - 更新日志助手 - 贡献指南生成器 - 架构决策记录模板 ### 4. 项目启动器 用于满足常见开发者需求的可重用模板： - 全栈应用启动器 - API 服务启动器 - CLI 工具启动器 - AI 应用启动器 - 开源代码仓库启动器 ### 5. 代码质量工作流 用于更安全变更的 AI 辅助工作流： - Pull request 摘要 - 代码审查清单 - 测试建议生成器 - 重构规划助手 - 安全和依赖审查助手 ### 6. 自动化模块 消除重复工作的小工具： - Issue 分类助手 - 发行说明生成器 - 环境设置清单 - 配置文件验证器 - 代码仓库健康报告 ## 可用 CLI WinterSolve 包含一个可用的离线优先 CLI。 运行代码仓库扫描： ``` wintersolve scan . ``` 构建完整的 Repo Brain 报告： ``` wintersolve brain . --format markdown ``` 保存 JSON 报告供工具使用： ``` wintersolve brain . --format json --output wintersolve-report.json ``` 生成 Markdown 报告： ``` wintersolve scan . --format markdown ``` 解释源文件： ``` wintersolve explain src/wintersolve/cli.py ``` 分析错误： ``` wintersolve debug --text "ModuleNotFoundError: No module named demo" ``` 建议文档改进： ``` wintersolve docs . --draft-readme ``` 审查本地 Git 变更： ``` wintersolve review . ``` ## 安装 ### 对于用户（推荐） 从 PyPI 安装发布的包： ``` pip install wintersolve ``` 或者使用 `pipx` 获取一个隔离且全局可用的命令： ``` pipx install wintersolve ``` 然后从任何项目运行它： ``` cd my-app wintersolve brain . ``` ### 对于贡献者（开发设置） 克隆代码仓库，并以可编辑模式与开发依赖一起安装： ``` git clone https://github.com/harshitkrhere/WinterSolve.git cd WinterSolve python -m venv .venv source .venv/bin/activate # Windows: .venv\Scripts\activate pip install -e .[dev] ``` 这将安装带有测试、lint 和类型检查依赖的包。`wintersolve` 命令可在虚拟环境内运行。 ### 不安装直接运行（快速测试） 从项目文件夹中： ``` $env:PYTHONPATH="src"; python -m wintersolve scan . ``` 或使用本地 PowerShell 助手： ``` .\scripts\wintersolve.ps1 scan . ``` ## 用法 查看 [docs/COMMANDS.md](docs/COMMANDS.md) 获取命令示例。 查看 [docs/GITHUB_LAUNCH.md](docs/GITHUB_LAUNCH.md) 获取 GitHub 安装、应用/网站使用、JSON 集成和 CI 示例。 ## 开发设置 WinterSolve 在运行时需要 `typer>=0.12` 和 `rich>=13.0`。 ### 安装 `wintersolve` 命令 要使其工作： ``` wintersolve scan . ``` 以可编辑模式安装项目： ``` python -m pip install -e . ``` 然后打开一个新的 PowerShell 窗口并运行： ``` wintersolve scan . ``` 运行测试： ``` PYTHONPATH=src python -m unittest discover -s tests ``` 在 Windows PowerShell 上： ``` $env:PYTHONPATH="src"; python -m unittest discover -s tests ``` ## 测试 WinterSolve 使用 Python 内置的 `unittest` 运行器。测试套件涵盖了代码仓库扫描、Repo Brain JSON 输出、命令检测、密钥脱敏、安全路径处理以及 Python/Node.js 混合项目检测。 ## 安全 查看 [SECURITY.md](SECURITY.md) 获取安全报告指南。 ## 许可证 WinterSolve 基于 MIT 许可证发布。请参阅 [LICENSE](LICENSE)。 ## 建议的代码仓库结构 ``` WinterSolve/ README.md docs/ PROJECT_VISION.md ROADMAP.md MODULES.md examples/ sample-reports/ templates/ prompts/ project-starters/ src/ wintersolve/ modules/ providers/ workflows/ tests/ ``` ## 项目价值观 - 解决真正的开发者问题。 - 倾向于实用的工作流，而不是华而不实的演示。 - 保持核心的模块化。 - 明确贡献路径。 - 尊重开发者隐私和项目所有权。 - 保持输出易读、可编辑且实用。 ## 状态 WinterSolve 处于早期产品基础阶段。 CLI 现在包含可用的 `brain`、`scan`、`explain`、`debug`、`docs` 和 `review` 工作流。下一步是通过更丰富的语言分析器、可选的 AI 增强以及适配 GitHub 的发布打磨来深化 Repo Brain。

标签：SOC Prime, 代码审查, 代码库管理, 安全扫描, 开发工具, 文档结构分析, 时序注入, 逆向工具, 错误基检测, 静态代码分析