SpecMap 命令行界面 (CLI)
结合Spec-Kit方法与RULEMAP框架的AI驱动规格化开发系统。
概述
SpecMap是一个全面的命令行界面(CLI)工具和MCP服务器,它支持在人工智能(AI)辅助下进行规格驱动的开发。它提供:
- RULEMAP框架7要素规范框架(角色、理解、逻辑、要素、情绪、受众、表现)
- 项目章程优质治理与原则
- 规格驱动的工作流程指定 → 明确 → 规划 → 任务 → 实施 → 质量保证
- AI代理集成支持Claude Code、Copilot、Cursor、Gemini等更多工具
- MCP服务器模型上下文协议服务器,实现无缝AI集成
- 克劳德编码技能预构建和自定义技能以实现工作流自动化
特点/特性
核心工作流程
- ✅ 项目初始化并建立治理结构
- ✅ 增强型RULEMAP规范
- ✅ 系统化的澄清流程
- ✅ 实施规划
- ✅ TDD(测试驱动开发)任务生成
- ✅ 质量评分(>= 8.0 分数阈值)
人工智能集成
- ✅ 支持多平台AI代理
- ✅ 用于Claude集成的MCP服务器
- ✅(表示正确、对号、确认等意思,具体含义需结合上下文) 克劳德编程技能 用于特定任务
- ✅ 代理交接协议
- ✅ 专门化的代理协调
质量保证
- ✅ 以宪法为基础的治理
- ✅ 规则映射(RULEMAP)合规评分
- ✅ 双重验证(规范+宪法)
- ✅ 全面的追踪ID
快速入门
安装
# Clone the repository
git clone https://github.com/your-org/specmap-cli.git
cd specmap-cli
# Install dependencies
pip install -e .初始化一个项目
specmap init my-awesome-app --type web-app --agent claude
cd my-awesome-app安装Claude代码技能
# Install all predefined SpecMap skills
specmap skill install-all
# Or install specific skills
specmap skill install specmap-reviewer创建您的第一个规范
specmap specify "User authentication with email and password"遵循工作流程
# 1. Clarify the specification
specmap clarify
# 2. Generate implementation plan
specmap plan
# 3. Create task breakdown
specmap tasks
# 4. Check project status
specmap status克劳德编码技能
SpecMap 包含强大的 Claude 代码集成功能:
预定义技能
- specmap评审员 - 审查规范以确保符合RULEMAP要求
- specmap规划器 - 制定实施计划
- SpecMap任务生成器 - 创建TDD(测试驱动开发)任务分解
- specmap-qa 翻译为中文是“规范映射-问答”或“规格映射-问答”,具体翻译可能根据上下文有所调整。 - 质量保证和合规性验证
- Specmap-charter-helper(可译为“规范映射-特许助手”或根据具体上下文调整为更贴切的表述) - 互动式项目章程完成
使用技能
在克劳德代码中:
/skill specmap-reviewer
Please review my specification管理技能
# View available templates
specmap skill templates
# List installed skills
specmap skill list
# Create custom skill
specmap skill create my-skill "Description" -c "Skill content here"
# Delete a skill
specmap skill delete my-skill看 SKILLS.md 翻译为中文是:“技能说明文件.md” 或 “技能列表文件.md”(具体翻译可能根据上下文有所调整,但基本意思是“关于技能的Markdown文件”) 以获取完整文档。
会话管理与备份
SpecMap 包含一个全面的会话管理系统,用于组织您的开发工作,并确保不会丢失任何内容。
什么是会话管理?
每次开发会议都是:
- 有组织的 - 一致的文件夹结构,命名清晰
- 被追踪的 - 完整的元数据和工件跟踪
- 有后盾支持的 - 在会话边界处自动备份
- 可恢复的 - 从任意检查点或备份中恢复
快速入门:使用会话
# Start a new session
python scripts/session-start.py "feature name" claude
# Create checkpoints during work
python scripts/session-checkpoint.py "milestone description"
# End session with backup
python scripts/session-end.py 8.5
# Create daily project backup
python scripts/backup-project.py自动会话管理(Claude 代码)
安装会话管理器技能以实现自动生命周期管理:
specmap skill install specmap-session-manager在克劳德代码中:
/skill specmap-session-manager
Let's work on the authentication feature克劳德将自动:
- 开始一个新的有条理的会议
- 在适当的时候设置检查点
- 追踪所有创建/修改过的文件
- 完成后以备份方式结束会话
会议结构
每次会话都会创建一个有条理的工作空间:
04-agents/sessions/active/2025-10-25-session-001-authentication/
├── artifacts/ # Files created during session
├── notes/ # Scratch work and ideas
├── decisions/ # Technical decisions documented
├── snapshots/ # Checkpoint backups
│ ├── checkpoint-001-15-00-00/
│ └── checkpoint-002-16-30-00/
├── session.yaml # Complete session metadata
├── summary.md # Session summary template
└── README.md # Session guide备份策略
会话备份 (自动的)
- 在您结束会话时创建
- 会话工作区的完整ZIP存档
- 存储在
04-agents/backups/sessions/
每日备份 (手册):
- 支持治理、规范、计划、跟踪
- 运行:
python scripts/backup-project.py - 储存在
04-agents/backups/daily/YYYY-MM-DD/
检查点 (在会议期间):
- 创建工作进度的快照
- 如有需要,可恢复到任意检查点
- 具备会话管理技能的自动化功能
恢复与还原
# List available backups
python scripts/restore-session.py --list-backups
# Restore from session backup
python scripts/restore-session.py --restore-backup
# List checkpoints for a session
python scripts/restore-session.py --list-checkpoints
# Restore from specific checkpoint
python scripts/restore-session.py --restore-checkpoint 用于会话的MCP工具
MCP服务器提供会话管理工具:
session_start()- 开始新会话session_checkpoint()- 创建检查点session_track_artifact()- 轨迹文件session_end()- 结束并存档会话session_list_active()- 列出活动会话create_daily_backup()- 每日备份
看见 docs/SESSION-MANAGEMENT.md 翻译为中文是:文档/会话管理.md 以获取完整文档。
MCP 服务器
SpecMap MCP服务器提供了用于AI集成的工具:
可用工具
项目管理:
specmap_init()- 初始化新项目specmap_status()- 获取项目状态
规范工作流程:
specmap_specify()- 创建规范specmap_clarify()- 运行澄清流程specmap_plan()- 制定实施计划specmap_tasks()- 创建任务分解
技能管理:
get_skill_templates()- 列出可用模板install_specmap_skill_template()- 安装模板install_all_specmap_skills()- 安装所有技能create_claude_skill()- 创建自定义技能list_claude_skills()- 列出已安装的技能delete_claude_skill()- 移除一个技能
配置
添加到您的Claude桌面配置中(~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"specmap": {
"command": "python",
"args": ["-m", "specmap_mcp.server"],
"cwd": "/path/to/specmap-cli/mcp-server"
}
}
}项目结构
my-project/
├── .claude/ # Claude Code integration
│ └── skills/ # Claude Code skills
├── .specmap/ # System configuration
├── 00-governance/ # Constitution + Charter
│ ├── constitution.md
│ └── project-charter.md
├── 01-specifications/ # RULEMAP specs
│ └── features/
│ └── feature-001/
│ ├── spec.md
│ ├── clarifications.md
│ └── research.md
├── 02-planning/ # Implementation plans
│ └── feature-001/
│ ├── plan.md
│ ├── tasks.md
│ └── technical-decisions.md
├── 03-implementation/ # Dev tracking
├── 04-agents/ # Agent management
│ ├── sessions/ # Session management
│ │ ├── active/ # Current sessions
│ │ └── archive/ # Completed sessions
│ ├── backups/ # Session & project backups
│ │ ├── daily/ # Daily backups
│ │ ├── sessions/ # Session backups
│ │ └── milestones/ # Milestone backups
│ └── session-summaries/ # Session logs
├── 05-quality-assurance/ # QA & validation
├── 06-documentation/ # Project docs
├── 07-project-tracking/ # Progress tracking
└── 08-deliverables/ # Final outputsCLI 命令
项目管理
specmap init # Initialize project
specmap status # View project status
specmap check # Check prerequisites规范工作流程
specmap specify # Create specification
specmap clarify # Run clarification
specmap plan # Generate plan
specmap tasks # Create tasks治理
specmap constitution # View/edit constitution
specmap charter # Manage charter代理管理
specmap agent activate # Activate agent
specmap agent status # View agents
specmap agent handoff # Transfer work技能管理
specmap skill templates # List templates
specmap skill install # Install template
specmap skill install-all # Install all
specmap skill list # List installed
specmap skill create # Create custom
specmap skill delete # Remove skillRULEMAP 框架
七要素规范框架:
- R - 角色与权限谁拥有并决定
- U - 理解与目标我们正在解决什么问题
- L - 逻辑与方法我们该如何解决它
- E - 元素与约束我们需要的和限制条件
- M - 情绪与体验它应该给人的感觉是怎样的
- A - 受众与利益相关者这是为谁准备的
- P - 表现与成功我们如何衡量成功
在实施之前,规范必须达到RULEMAP评分≥8.0。
工作流程阶段
1. 初始化
- 创建项目结构
- 建立宪法
- 完整租约(RULEMAP)
2. 规格说明
- 创建功能规格
- 运行澄清
- 达到质量标准
3. 规划
- 制定实施计划
- 创建任务分解结构
- 验证可行性
4. 实施
- 遵循TDD(测试驱动开发)工作流程
- 代理引导式开发
- 持续验证
5. 质量保证
- 合宪性
- RULEMAP评分
- 部署准备
AI代理支持
SpecMap支持多个AI平台:
- 克劳德·科德 (推荐)- 完整的MCP集成 + 技能
- GitHub Copilot - 集成开发环境(IDE)集成
- 光标 - 编辑器集成
- 双子座 - 谷歌人工智能集成
- 风帆冲浪 - 代码助手
- Qwen/OpenCode - 开源选项
示例
功能开发完成
# 1. Initialize project
specmap init my-saas-app --type web-app --agent claude
cd my-saas-app
# 2. Install Claude Code skills
specmap skill install-all
# 3. Complete governance
specmap charter --complete
# 4. Create feature specification
specmap specify "User authentication with OAuth2 and JWT"
# 5. Clarify and improve
specmap clarify
# 6. Generate implementation plan
specmap plan
# 7. Create TDD tasks
specmap tasks
# 8. Implement (with Claude Code)
# In Claude Code:
/skill specmap-planner
/skill specmap-task-generator
# 9. Quality validation
# In Claude Code:
/skill specmap-qa创建自定义技能
# Create a custom API review skill
specmap skill create api-reviewer "Review API endpoints" -c "
# API Endpoint Reviewer
Review the API endpoints for:
- RESTful design
- Proper HTTP methods
- Error handling
- Authentication
- Rate limiting
- Documentation
"
# Use it in Claude Code
# /skill api-reviewer配置
项目配置
.specmap/config.yaml:
project:
name: my-project
type: web-app
version: 1.0.0
created: 2025-10-18
agents:
base_agent: claude
workflow:
current_phase: specification技能配置
技能存储在 .claude/skills/ 作为Markdown文件:
---
name: my-skill
description: What it does
created: 2025-10-18
---
# Skill Instructions
...发展
运行测试
# Install dev dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Run specific test
pytest tests/test_skills.pyMCP服务器开发
cd mcp-server
python -m specmap_mcp.server文档
- 技能指南 - 完整的技能文档
- 会话管理 - 会话与备份系统
- MCP服务器API - MCP服务器参考
- RULEMAP 指南 - 框架详情
- CLI 参考手册 - 命令参考
故障排除
技能未加载
# Check skills directory
ls .claude/skills/
# Reinstall skills
specmap skill install-allMCP服务器问题
# Test MCP server
python -m specmap_mcp.server
# Check configuration
cat ~/Library/Application\ Support/Claude/claude_desktop_config.json导入错误
# Ensure SpecMap is installed
pip install -e .
# Check Python path
python -c "import sys; print(sys.path)"做出贡献
欢迎投稿!请:
- 克隆该仓库
- 创建一个特性分支
- 为新功能添加测试
- 更新文档
- 提交拉取请求
许可证
MIT 许可证 - 请参阅 LICENSE 文件
支持
路线图
- \[x\] 核心工作流实现
- \[x\] MCP服务器集成
- \[x\] 克劳德代码技能系统
- \[x\] 会话管理与备份系统
- \[ \] 网页仪表盘
- \[ \] VS Code 扩展
- \[ \] 团队协作功能
- \[ \] 规格模板库
- \[ \] CI/CD 集成
- \[ \] 分析与见解
功劳/贡献
构建于:
- 针对MCP服务器的FastMCP
- 点击以访问命令行界面(CLI)
- 丰富的终端用户界面
- 用于配置的PyYAML
______________________________________________________________________
用Claude代码制作 - 基于AI的规格驱动开发
