关于 chief-init
chief-init 通过简短访谈创建项目的 `.chief/project.md`,供配置 chief-agent 项目上下文的团队使用。它会检查前置条件,并在覆盖现有配置前要求确认和备份。
主要功能
- 01检查 chief-agent 是否已安装
- 02访谈项目背景信息
- 03确认 Markdown 草稿
- 04覆盖前备份现有文件
- 05仅创建 `.chief/project.md`
适用场景
- 01记录仓库技术栈与开发命令
- 02为 chief-agent 设置项目上下文
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ thaitype/ chief --skill chief-init安装后在 Claude Code 中输入/chief-init确认已加载。
详细介绍
你正在为项目初始化 .chief/project.md。这是此技能唯一会创建的内容。里程碑、规则和其他 .chief/ 内容会在 chief-agent 首次需要时创建。
步骤
1. 前置检查
- 确认框架已安装:
.agents/agents/chief-agent.md必须存在。如果缺失,告知用户先运行/chief-install,然后停止。 - 检查
.chief/project.md是否已存在。- 如果存在 → 询问用户:“
.chief/project.md已存在。更新 / 覆盖 / 取消?” - 如果选择覆盖,继续之前先将当前文件备份到
.chief/project.md.bak。 - 如果选择更新,先读取当前内容,并将访谈作为一次完善过程。
- 如果选择取消,则停止。
- 如果存在 → 询问用户:“
- 如果
.chief/不存在,则创建它。
2. 访谈用户
依次了解以下主题,每次只问一个简短问题。问题要聚焦。等待用户回答后再继续。如果用户回答“skip”或“n/a”,则跳过该主题。
- 项目名称和一句话简介。
- 技术栈 — 主要语言、框架、运行时、数据库、关键库。
- 开发命令 — 如何安装依赖、运行开发环境、运行测试、lint、类型检查、构建。
- 架构概述 — 主要模式(例如 Repository Pattern、Service Layer、六边形架构、monorepo 等)。
- 目录结构 — 顶层文件夹及其用途。
- 重要开发规则 — 开发者必须遵循的约定(提交风格、分支策略、格式化、测试要求等)。
如果用户对某个主题不确定,根据你在仓库中能看到的文件(package.json、pyproject.toml、Cargo.toml、Makefile、README.md 等)提出合理的默认建议,并向用户确认。
3. 显示草稿并确认
以格式化的 Markdown 显示拟定的 .chief/project.md 内容。然后询问一次:“将此内容写入 .chief/project.md 吗?”
如果用户要求修改,则应用修改并再次确认。最多进行三轮;如果难以达成一致,则写入当前草稿,并告知用户可以手动编辑。
4. 写入文件
写入 .chief/project.md。使用以下结构(省略空章节,不要保留占位文本):
# Project Configuration
## Project
{name and one-line summary}
## Development Commands
{commands as a list or table}
## Architecture Overview
### Tech Stack
{...}
### Key Architectural Patterns
{...}
### Directory Structure
{...}
### Important Development Rules
{...}
5. 后续步骤
告知用户:
.chief/project.md现已设置。chief-agent 会读取该文件以了解项目上下文。- 要启动一个里程碑:
/chief-plan(按需创建.chief/milestone-N/)。 - 要在规划好里程碑后自主运行:
/chief-autopilot。 - 之后可以在
.chief/_rules/_standard/、_contract/、_goal/、_verification/下添加规则 — chief-agent 会在首次添加规则时创建相应的子文件夹。
重要规则
- 此技能只创建
.chief/(如果不存在)和.chief/project.md。不要搭建里程碑、规则子文件夹或_template/。 - 未经用户明确确认,绝不覆盖已有的
project.md;务必先备份到.bak。 - 如果
.agents/agents/chief-agent.md缺失,不要继续 — 指引用户运行/chief-install。 - 访谈要简短。每次只问一个聚焦的问题,不要把多个问题合并。
- 参考:chief 仓库中的
docs/example-chief/提供了规范布局示例。
评论
支持 Markdown