一句命令看透任何项目——全量分析架构、业务、数据,生成导航手册 HTML,自动写入 AGENTS.md 给 AI 装上项目记忆。零门槛上船。
请把 https://github.com/N0tsLabs/ship-zero.git 克隆到你的 skills 目录
去 ship-zero 目录执行 git pull
每次运行前自动 pull 一下,确保使用的总是最新版本。
使用 ship-zero 分析当前项目
AI 自动:扫描项目 → 分析架构 → 反推业务 → 并行深读 → 生成 docs/project-overview.md(AI 读)+ docs/project-overview.html(人看)→ 写入 AGENTS.md。零门槛上船。
| 章节 | 内容 |
|---|---|
| 一句话概览 | 项目是什么、给谁用 |
| 技术栈一览 | 语言、框架、数据库 |
| 架构全景 | 分层 Mermaid 架构图 |
| 目录导航 | 每个目录干什么 |
| 数据模型 | ER 图 + 实体速查 |
| API 全景 | 全部接口按模块分组 |
| 核心流程 | 业务 Mermaid 流程图 |
| 认证权限 | 认证机制 + 角色模型 |
| 配置清单 | 环境变量 + 默认值 |
| 开发指南 | 启动步骤 + 常用命令 |
| 代码约定 | 设计模式 + 编码规范 |
| 外部依赖 | 三方库 + 外部集成 |
| 已知坑点 | 容易出 Bug 的地方 |
| 规模快照 | 文件、接口、实体统计 |
| 文件 | 说明 |
|---|---|
SKILL.md |
AI 执行的完整行为指令 |
reference/html-template.md |
HTML 模板规范(OLED Dark + Linear/Vercel 风) |
README.md |
本文件 |