用途
Setup Guide 是一个用于生成完整本地开发环境搭建指南的技能。它的目标不是简单复述 README,而是通过实际扫描项目、检查当前系统环境、验证每一步是否可用,最终产出一份可直接执行的搭建文档。
主要能力
-
自动检测项目技术栈:扫描项目文件以识别语言与运行时(Node.js、Python、Go、Ruby、Java、Rust、PHP 等)、包管理器(npm、yarn、pnpm、bun、pip、poetry、bundler、composer 等)、数据库与服务(通过 docker-compose、.env 示例、Prisma schema 等推断 PostgreSQL、MySQL、MongoDB、Redis、Elasticsearch、RabbitMQ、Kafka 等),以及基础设施工具(make、docker、terraform、kubectl、github-actions 等)。
-
检查当前系统环境:检测操作系统与 Shell,逐一检查所需工具是否已安装及版本是否满足要求,对缺失项给出明确提示。
-
生成分步搭建指南:根据检测结果,为不同技术栈(Node.js/TypeScript、Python/Django、Go、Ruby on Rails、Java/Spring Boot、PHP/Laravel、Rust、React Native、Flutter、Monorepo/Turborepo 等)生成从克隆仓库、安装依赖、配置环境变量、启动基础设施、数据库迁移到启动开发服务器的完整步骤。
-
验证清单:提供基础设施、应用、开发工具三个层面的检查项,确认搭建是否成功。
-
常见问题排查:列出首次运行时常见问题(端口占用、数据库连接失败、模块缺失、权限问题、环境变量缺失、迁移失败、版本不匹配、Docker 空间不足、种子数据缺失等)及对应解决方案。
-
IDE 与编辑器配置建议:针对 VS Code、JetBrains 系列、Vim/Neovim 给出推荐扩展、设置和插件建议。
-
常用命令参考:整理日常开发命令表,包括启动服务、运行测试、代码检查、格式化、基础设施管理、数据库操作、构建等。
-
访问与凭据说明:列出本地开发服务的 URL 与凭据、种子用户账号、外部服务凭据获取方式,并提醒不要在生产环境使用本地凭据。
-
后续步骤建议:引导用户熟悉代码库、选择第一个任务、了解关键联系人。
使用方式
该技能以结构化流程运行:先检测项目栈,再检查当前系统,然后生成分步指南,最后附上验证清单、排查表、命令参考和后续步骤。它强调自动检测而非询问用户,实际运行命令验证每一步,根据操作系统提供正确命令,跳过已完成的步骤,并在发现关键阻塞项时立即提示。
适用场景
- 新成员加入项目时需要快速搭建本地开发环境
- 项目文档缺失或过时,需要生成准确的搭建指南
- 跨平台(macOS/Linux/Windows)环境搭建
- 多技术栈项目或 Monorepo 的搭建说明
限制
- 具体支持的平台、收费方式、价格等信息暂未提供。
- 该技能依赖项目文件的存在与可读性,若项目结构不标准可能影响检测准确性。
- 实际搭建效果取决于当前系统环境与项目本身的可运行性。