github/spec-kit - 快速上手

由于 trendforge.devlive.top 访问受限，请切换到 trendforge.devlive.org 域名

项目介绍快速开始学习路径项目截图 3 贡献者 70 增长趋势 Commit 历史代码统计生态关系项目时间线项目竞品上榜历史

Spec Kit 5分钟快速开始

使用 Spec Kit 快速体验规范驱动开发，通过命令行工具定义需求并生成代码实现。

环境要求

支持的操作系统

macOS Windows Linux

运行环境

Python 3.8+ 必需

所需工具

Python 包管理器，用于安装 Specify CLI

必需

操作步骤

安装 uv 包管理器

uv 是 Specify CLI 的推荐安装工具。

安装 uv（macOS/Linux）

curl -LsSf https://astral.sh/uv/install.sh | sh

安装 uv（Windows）

powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

预期结果：：安装成功后，终端会显示 uv 的版本信息或安装路径。

如果已安装 uv，可跳过此步。

安装 Specify CLI

使用 uv 安装 Specify CLI 工具。

从 PyPI 安装最新稳定版 Specify CLI

uv tool install specify-cli

预期结果：：安装完成后，运行 `specify --version` 应显示版本号。

如果需要安装特定版本，可以使用 `uv tool install specify-cli==v0.12.11`（请替换为实际版本号）。

初始化项目

在目标目录创建 Spec Kit 项目结构。

创建并进入新项目目录

mkdir my-speckit-project && cd my-speckit-project

初始化 Spec Kit 项目配置

specify init

预期结果：：初始化成功后，目录下会生成 `.specify/` 等配置文件。

建议在新目录中运行，避免文件冲突。

启动 AI 编码代理并定义规范

使用支持的 AI 编码代理（如 GitHub Copilot）执行 Spec Kit 命令。

启动你的 AI 编码代理（如 Copilot、Cursor 等）

# 在 AI 编码代理中输入以下命令（以 GitHub Copilot CLI 为例）

使用 /speckit.specify 命令定义功能需求

/speckit.specify 我要构建一个任务清单应用，用户可以添加、删除和标记任务完成

预期结果：：AI 代理会生成一个规范文档（通常为 Markdown），描述功能需求和用户故事。

你可以根据自己的需求修改描述，专注于'做什么'而不是'怎么做'。

生成技术计划并执行

让 Spec Kit 根据规范生成技术实现计划并执行。

指定技术栈，生成实现计划

/speckit.plan 使用 Python 和 Flask 框架，SQLite 数据库

执行所有任务，生成代码实现

/speckit.implement

预期结果：：AI 代理会逐步生成代码文件，并在项目目录中创建相应的实现。

执行过程中可以查看生成的代码，了解 Spec Kit 的工作方式。

验证成功

确认 Spec Kit 工作流程已正确执行。

项目目录中存在 `.specify/` 配置文件夹

使用 `/speckit.specify` 命令后生成了规范文档

使用 `/speckit.implement` 后项目目录中出现了代码文件

快速提示

兼容性

运行 `specify integration list` 查看所有支持的 AI 编码代理。

最佳实践

使用 `/speckit.constitution` 命令定义项目开发准则，提升生成代码质量。

扩展性

社区扩展和预设可以增强 Spec Kit 的功能，可在文档中探索。

常见问题

运行 `specify` 命令提示 'command not found' 或 '无法识别'。

确保 uv 安装路径在系统 PATH 中。尝试重新安装或手动将 uv 的 bin 目录添加到 PATH。

AI 编码代理无法识别 `/speckit.*` 命令。

确认已成功运行 `specify init` 生成了 `.specify/` 目录。不同代理的命令格式可能略有不同，请参考文档中的'支持的 AI 编码代理集成'部分。

安装 uv 时网络连接失败。

检查网络连接，或尝试使用代理。也可以直接通过 `pip install specify-cli` 从 PyPI 安装 Specify CLI（但官方推荐 uv）。

下一步

观看官方视频概览

访问 https://www.youtube.com/watch?v=a9eR1xsfvHg 查看 Spec Kit 的实际操作演示。

探索社区资源

在 Spec Kit 文档站点查看社区贡献的扩展、预设和演练场景。

阅读核心理念

深入了解规范驱动开发（SDD）的核心哲学，优化你的开发流程。