specbios
v1.0.0
Published
Upgrade AI programming from chat memory to recoverable project system - Documentation-driven AI programming orchestrator
Maintainers
Readme
SpecBIOS
English | 中文
把 AI 编程从"聊天记忆"升级成"可恢复的项目系统"
SpecBIOS 是一个文档驱动的 AI 编程调度器,通过结构化文档持久化项目意图和进度,让 AI 编程项目在任何时候都能恢复上下文,支持多项目协同管理和智能任务规划。
核心特性
🔄 可恢复性
- 用文档记录项目意图、架构、任务和进度
- 上下文丢失后可快速恢复
- 跨会话保持项目连续性
🎯 执行器分离
- SpecBIOS 负责调度,不直接写代码
- 支持多种执行器(Aider、Claude Code)
- 自由切换,利用各执行器优势
🏢 工作区管理
- 统一管理多个相关项目
- 跨项目依赖声明和验证
- 模板化快速创建标准工作区
🤖 AI 增强
- 智能任务拆分建议
- 执行器推荐
- 依赖关系自动识别
- 支持多 AI 提供商(Anthropic、OpenAI)
📦 模板市场
- 本地模板管理
- 快速创建标准化项目
- 分享最佳实践
快速开始
安装
npm install -g specbios初始化项目
# 创建新项目
mkdir my-project
cd my-project
# 初始化 SpecBIOS 项目
specbios init
# 查看恢复上下文
specbios resume基本工作流
# 1. 规划任务
specbios plan "实现用户登录功能"
# 2. 调度执行器
specbios dispatch --executor aider
# 3. 同步任务状态
specbios sync
# 4. 查看进度
specbios resume核心命令
项目管理
# 初始化项目
specbios init [--template <template-name>]
# 查看恢复上下文
specbios resume
# 规划任务
specbios plan <description>
# 调度执行器
specbios dispatch [--executor <name>] [--auto-run]
# 同步任务状态
specbios sync工作区管理
# 初始化工作区
specbios workspace init --name <workspace-name>
# 列出工作区项目
specbios workspace list
# 查看工作区信息
specbios workspace info
# 切换当前项目
specbios workspace switch <project-name>
# 添加项目
specbios project create --name <name> --path <path>
# 列出项目
specbios project list
# 查看项目信息
specbios project info <project-name>
# 声明依赖
specbios project add-dependency <project> --depends-on <dependency>
# 验证依赖
specbios project validate-dependencies模板管理
# 发布模板
specbios workspace template publish <workspace> \
--name <template-name> \
--display-name "显示名称" \
--description "模板描述" \
--author "作者" \
--tags "tag1,tag2"
# 列出模板
specbios workspace template list [--tag <tag>] [--search <keyword>]
# 查看模板详情
specbios workspace template info <template-name>
# 安装模板
specbios workspace template install <template-name> --name <workspace-name>
# 删除模板
specbios workspace template remove <template-name>
# 更新模板
specbios workspace template update <template-name> --from <workspace>AI 增强功能
# AI 任务拆分建议
specbios ai split <task-description>
# AI 执行器推荐
specbios ai recommend <task-description>
# AI 依赖关系识别
specbios ai recognize-depsGit 集成
# 安装 Git hooks
specbios hooks install [--force]
# 卸载 Git hooks
specbios hooks uninstall
# 查看 hooks 状态
specbios hooks status任务管理
# 添加新任务
specbios task add <title> [--description <text>]
# 编辑任务
specbios task edit <taskId> [--title <text>] [--status <status>]
# 列出所有任务
specbios task list [--status <status>]
# 分析任务依赖关系
specbios task analyze-deps [taskId] [--dry-run]配置
项目配置文件
SpecBIOS 使用 .specbios/config.json 存储项目配置:
{
"projectName": "my-project",
"defaultExecutor": "aider",
"executors": {
"aider": {
"command": "aider",
"args": ["--yes-always"]
},
"claude-code": {
"command": "claude",
"args": []
}
},
"aiSplit": {
"provider": "anthropic",
"apiKey": "your-api-key",
"model": "claude-3-5-sonnet-20241022",
"baseURL": "https://api.anthropic.com/v1/messages"
}
}工作区配置
工作区配置存储在 .specbios/workspace.json:
{
"name": "my-workspace",
"projects": [
{
"name": "frontend",
"path": "packages/frontend",
"description": "前端项目"
},
{
"name": "backend",
"path": "packages/backend",
"description": "后端项目"
}
],
"dependencies": [
{
"project": "frontend",
"dependsOn": "backend"
}
]
}使用场景
场景 1:单项目开发
# 初始化项目
specbios init
# 规划第一个任务
specbios plan "搭建项目基础架构"
# 使用 Aider 执行
specbios dispatch --executor aider --auto-run
# 同步状态
specbios sync
# 规划下一个任务
specbios plan "实现用户认证模块"场景 2:多项目工作区
# 创建工作区
specbios workspace init --name fullstack-app
# 添加前端项目
specbios project create --name frontend --path packages/frontend
# 添加后端项目
specbios project create --name backend --path packages/backend
# 声明依赖
specbios project add-dependency frontend --depends-on backend
# 切换到后端项目
specbios workspace switch backend
# 在后端项目中工作
specbios plan "实现 API 接口"
specbios dispatch --executor aider --auto-run场景 3:使用模板快速创建
# 列出可用模板
specbios workspace template list
# 安装全栈模板
specbios workspace template install fullstack-demo --name my-app
# 进入工作区
cd my-app
# 查看项目列表
specbios workspace list
# 开始开发
specbios workspace switch backend
specbios plan "实现数据库模型"场景 4:AI 辅助开发
# 获取任务拆分建议
specbios ai split "实现用户管理系统"
# 获取执行器推荐
specbios ai recommend "重构前端组件架构"
# 识别项目依赖关系
specbios ai recognize-deps文档结构
SpecBIOS 项目包含以下核心文档:
docs/
├── README.md # 文档索引
├── 00-project-dossier.md # 项目档案
├── 01-architecture.md # 架构设计
├── 02-data-model-and-apis.md # 数据模型和接口
├── 03-scope-and-mvp.md # 范围和 MVP
├── 04-roadmap-and-progress.md # 路线图和进度
└── 05-live-task-board.md # 实时任务板这些文档是项目的核心,记录了:
- 项目意图和背景
- 架构设计和技术决策
- 任务规划和执行进度
- 问题和解决方案
执行器支持
Aider
# 安装 Aider
pip install aider-chat配置 Aider,编辑 .specbios/config.json:
{
"defaultExecutor": "aider",
"executors": {
"aider": {
"command": "aider",
"args": ["--yes-always"]
}
}
}Claude Code
# 安装 Claude Code
npm install -g @anthropic-ai/claude-code配置 Claude Code,编辑 .specbios/config.json:
{
"executors": {
"claude-code": {
"command": "claude",
"args": []
}
}
}AI 提供商配置
Anthropic
编辑 .specbios/config.json:
{
"aiSplit": {
"provider": "anthropic",
"apiKey": "your-api-key",
"model": "claude-3-5-sonnet-20241022"
}
}OpenAI
编辑 .specbios/config.json:
{
"aiSplit": {
"provider": "openai",
"apiKey": "your-api-key",
"model": "gpt-4"
}
}自定义 baseURL(本地模型/代理)
编辑 .specbios/config.json:
{
"aiSplit": {
"provider": "openai",
"baseURL": "http://localhost:11434/v1/chat/completions",
"model": "llama2"
}
}开发
从源码运行
# 克隆仓库
git clone https://github.com/yourusername/specbios.git
cd specbios
# 安装依赖
npm install
# 链接到全局
npm link
# 运行命令
specbios --help运行测试
npm test常见问题
Q: SpecBIOS 和 Cursor/Kiro 有什么区别?
A: SpecBIOS 不是代码编辑器或 IDE 插件,而是一个调度器:
- 职责分离:SpecBIOS 负责项目管理和任务规划,执行器负责代码生成
- 可恢复性:通过文档持久化项目状态,不依赖聊天记忆
- 执行器自由:可以切换不同的执行器,不被单一工具绑定
- 多项目支持:原生支持工作区和多项目协同
Q: 我需要安装执行器吗?
A: 是的,SpecBIOS 本身不生成代码,需要配合执行器使用。推荐:
- Aider:适合快速迭代和小型修改
- Claude Code:适合复杂重构和架构设计
Q: 文档会不会太多?
A: 文档是 SpecBIOS 的核心能力,不是负担:
- 文档记录项目意图,让 AI 能恢复上下文
- 文档是团队协作的基础
- 文档是知识沉淀的载体
Q: 支持哪些 AI 模型?
A: 支持所有兼容 OpenAI/Anthropic API 的模型:
- Anthropic Claude 系列
- OpenAI GPT 系列
- 本地模型(通过 Ollama 等)
- 第三方 API(OpenRouter、Azure OpenAI 等)
Q: 可以在现有项目中使用吗?
A: 可以,在现有项目目录运行 specbios init 即可。SpecBIOS 只会创建 docs/ 和 .specbios/ 目录,不会影响现有代码。
贡献
欢迎贡献代码、报告问题或提出建议!
报告问题
在 GitHub Issues 提交问题。
贡献代码
- Fork 仓库
- 创建特性分支 (
git checkout -b feature/amazing-feature) - 提交更改 (
git commit -m 'Add amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 创建 Pull Request
许可证
MIT License - 详见 LICENSE 文件
致谢
SpecBIOS 的开发过程本身就使用了 SpecBIOS 的理念——文档驱动、可恢复、结构化。感谢所有为这个项目提供灵感和帮助的人。
链接
SpecBIOS - 让 AI 编程项目可恢复、可管理、可协作
