Skip to content

Commit 728ca7f

Browse files
committed
docs: improve README product overview
1 parent 392b715 commit 728ca7f

2 files changed

Lines changed: 85 additions & 18 deletions

File tree

‎README.md‎

Lines changed: 84 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,86 @@
22

33
[![License](https://img.shields.io/badge/license-AGPL--3.0-green)](LICENSE)
44

5-
DevCodex 是面向 AI 编程宿主的工作流运行时和宿主适配包。它通过 npm 安装到用户环境,将同一套任务路由、Skill 加载、Hook / 指令适配、报告和记忆写入机制接入 Codex、Claude Code、GitHub Copilot、Gemini CLI 和 Grok。
5+
DevCodex 是面向 AI 编程宿主的工作流运行时和宿主适配包。它通过一个 npm 全局包,把上下文、记忆、80+ 内置 Skill、报告与验证闭环接入 Codex、Claude Code、GitHub Copilot、Gemini CLI 和 Grok,让不同宿主在同一个项目里按更一致的开发流程协作。
66

7-
安装完成后,DevCodex 在新会话中按用户请求的意图进入开发、修复、分析、审计等流程,并按需加载内置 Skill 或工作区 Skill。不同宿主的 Hook、指令和插件能力不完全相同;DevCodex 会按宿主能力使用可用的执行方式,并在能力不足时退回指令约束。
7+
如果你经常遇到 AI 新会话忘记项目背景、长任务中途断线、不同宿主规则不一致、修复过程没有记录、验证结果说不清这些问题,DevCodex 的目标就是把“随口聊天式开发”变成有上下文、有流程、有记录、可继续的 AI 编程协作。
8+
9+
```bash
10+
npm install -g devcodex
11+
devcodex --version
12+
```
13+
14+
安装或更新后,重新打开宿主的新会话即可开始使用。
815

916
DevCodex 不替代业务框架、GitHub CI、安全审计或人工评审。它也不接管 Codex、Claude Code 等宿主原有的个人 Skill、项目指令或配置文件。
1017

11-
## DevCodex 是什么?
18+
## 为什么需要 DevCodex?
19+
20+
AI 编程真正难的通常不是让模型写一段代码,而是让它在真实项目里稳定完成一个任务:
21+
22+
- 新会话不知道项目结构、约定、历史决策和当前进度。
23+
- 长任务容易断在一半,下一轮很难准确接上。
24+
- Codex、Claude Code、GitHub Copilot、Gemini CLI 和 Grok 各有自己的配置和能力,项目规则很容易分散。
25+
- 只有 prompt 或零散 Skill 时,缺少从需求、实现、验证到报告的闭环。
26+
- 项目自己的流程、检查清单和团队约定很难跨宿主复用。
27+
28+
DevCodex 把这些能力组合成一个本地工作流入口:先理解当前任务,再按需读取上下文和记忆,选择合适的 Skill 与工作流,最后把关键过程、验证和结果沉淀下来。
29+
30+
## DevCodex 解决什么问题?
31+
32+
| 问题 | DevCodex 怎么处理 | 用户得到什么 |
33+
|------|-------------------|--------------|
34+
| 每次都要重新解释项目背景 | 按任务意图读取必要的项目上下文、历史记忆和相关源码 | 少重复说明,AI 更快进入有效状态 |
35+
| 长任务和新会话容易断 | 把任务过程写入报告和文件记忆 | 后续会话可以围绕真实记录继续 |
36+
| 多个 AI 宿主规则不一致 | 一个 npm 包刷新五个宿主的用户级适配 | 切换宿主时保留同一套工作流习惯 |
37+
| 只有 prompt,没有执行闭环 | 开发、修复、分析、审计等任务都有过程、边界和验证记录 | 更容易复盘,也更容易发现“假完成” |
38+
| 项目私有流程难复用 | 支持在项目里添加工作区 Skill | 你的流程、检查清单和团队约定可被五宿主共享 |
39+
40+
## 核心特色
41+
42+
| 特色 | 说明 |
43+
|------|------|
44+
| 五宿主一个入口 | 支持 Codex、Claude Code、GitHub Copilot、Gemini CLI 和 Grok。不同宿主的 Hook、指令和插件能力不完全相同;DevCodex 会按宿主能力使用可用执行方式。 |
45+
| 上下文按需进入会话 | 不把所有资料一股脑塞给 AI,而是根据当前任务选择必要的项目资料、记忆和源码线索。 |
46+
| 文件记忆与长任务恢复 | 将关键过程写入当前项目的报告和记忆,减少“上一轮做到哪了”的断层。 |
47+
| 80+ 内置 Skill | 覆盖开发、修复、审计、发布、文档、架构、质量、安全、SRE、平台生态、产品与体验等专业场景。 |
48+
| 报告与验证闭环 | 任务结束时沉淀结果、验证命令和剩余风险,让交付不是只靠一句“完成了”。 |
49+
| 工作区 Skill | 用户可以在项目下添加自己的 Skill,让项目流程跨五宿主复用。 |
50+
| 本地优先 | 安装包刷新本地用户级宿主适配;普通使用不需要启动额外后台服务。 |
51+
| 原生资产共存 | DevCodex 不扫描、复制、合并、覆盖或删除这些用户资产。宿主自己的 Skill、项目指令和个人配置继续按原宿主规则生效。 |
52+
53+
## 它如何工作?
1254

13-
DevCodex 给五个宿主提供同一套开发工作流入口:
55+
你仍然在熟悉的宿主里用自然语言发起请求。DevCodex 在新会话中按用户请求的意图进入开发、修复、分析、审计等流程,并按需加载内置 Skill 或工作区 Skill。
1456

15-
- Codex
16-
- Claude Code
17-
- GitHub Copilot
18-
- Gemini CLI
19-
- Grok
57+
```text
58+
用户请求
59+
→ 判断任务意图
60+
→ 读取必要上下文和记忆
61+
→ 加载匹配的内置 Skill 或工作区 Skill
62+
→ 执行开发 / 修复 / 分析 / 审计等流程
63+
→ 输出结果、验证和报告
64+
→ 写入记忆,方便后续会话继续
65+
```
66+
67+
这里描述的是用户能感知的流程;不同宿主底层能力不同,DevCodex 会按当前宿主可用能力执行或回退。
68+
69+
## 适合谁?
2070

21-
它主要处理四件事:
71+
- 同时使用 Codex、Claude Code、GitHub Copilot、Gemini CLI 或 Grok 的开发者。
72+
- 经常让 AI 处理跨文件、跨轮次、需要验证的开发任务的人。
73+
- 希望项目约定、检查清单、发布流程或团队规则能被 AI 稳定遵守的人。
74+
- 想把自己的项目流程沉淀成可复用工作区 Skill 的用户。
2275

23-
1. 按用户请求识别任务意图,例如开发、修复、分析、审计。
24-
2. 按需加载 DevCodex 内置 Skill 或当前项目的工作区 Skill。
25-
3. 在宿主支持时使用 Hook;宿主能力不足时使用指令约束作为回退。
26-
4. 将关键过程写入当前项目的报告和记忆。
76+
## 5 分钟开始
2777

28-
## 系统要求
78+
### 系统要求
2979

3080
- Node.js `>=18`
3181
- npm
3282
- 至少一个受支持的 AI 编程宿主:Codex、Claude Code、GitHub Copilot、Gemini CLI 或 Grok
3383

34-
## 安装 Node.js
84+
### 安装 Node.js
3585

3686
先确认本机是否已有 Node.js 和 npm:
3787

@@ -54,9 +104,11 @@ npm -v
54104

55105
如果 Node.js 版本低于 18,请先升级 Node.js。
56106

57-
## 安装
107+
### 安装 DevCodex
58108

59-
安装前请确认 npm registry 上的版本与本文档对应;如果 registry 上的版本不是当前文档对应版本,不要把下面命令当作当前版本安装。
109+
npm 模块名称是 `devcodex`,不带组织 scope。
110+
111+
安装前建议确认 npm registry 上的版本与本文档对应;如果 registry 上的版本不是当前文档对应版本,不要把下面命令当作当前版本安装。
60112

61113
```bash
62114
npm install -g devcodex
@@ -65,6 +117,20 @@ devcodex --version
65117

66118
安装完成后,重新打开 Codex、Claude Code、GitHub Copilot、Gemini CLI 或 Grok 的新会话。
67119

120+
### 第一次怎么用
121+
122+
在新的宿主会话里,直接用自然语言发起任务即可,例如:
123+
124+
```text
125+
分析当前项目,告诉我最应该先改进的三个问题。
126+
```
127+
128+
```text
129+
阅读这个仓库,帮我修复当前失败的 GitHub CI。
130+
```
131+
132+
DevCodex 会按任务意图选择流程和 Skill。普通使用者不需要手动配置内置 Skill。
133+
68134
## 更新
69135

70136
```bash

‎changelogs/unreleased.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
> **当前**: v1.15.3 已归档到 `changelogs/releases/v1.15.3.md`;本文件仅保留历史锚点索引与镜像供 validate 探针消费。发版后新实现再写入下方「当前未发布」。
55
66
## 当前未发布实现候选
7+
- **README 产品入口改版**:公共 README 从最低安装说明升级为面向使用者的产品入口;首屏补充问题、价值和 `npm install -g devcodex` CTA,突出上下文、记忆、80+ 内置 Skill、五宿主、报告验证闭环、工作区 Skill 与宿主原生资产共存边界;安装、更新、卸载仍保持一个命令,内置 Skill 新会话自动按意图生效。
78
- **UserVisibleReplyLayoutV1(五宿主同源 · 人话优先)**:入口检查推荐 PC0~PC7 表格人话(禁止进度缩写/折叠行);完成态增加「复审验证(白话)」;`FinalValidationSummaryV1` 强制白话在上、命令+exitCode 证据在下(共享 `shared/compliance/validation-summary.md`);`composeEntryCheckBlock` / `precheck-status` / `17-compliance` / `user-visible-output-contract` / compliance Skill / 01-common / 16-report 同源;host-projections 重生。
89
- **UserVisibleNoisePolicyV1(降噪)**:入口检查始终必出;未宣称工作完成时用户面不贴完成检查/FVS/FC 全表/产物表;宣称完成且全绿用短 FVS;失败/缺口才展开。Stop 以 `workDoneClaimed` 替代「出现完成检查标题即完成」;`lifecycle-stop-gate` / FVS classifier / compliance 同步。
910
- **控制面规范资产去重与确定性组合**:新增 `content-source/` 作为 135 个 instruction/prompt/Skill Markdown 的唯一手写根,保留既有 tracked delivery 路径;22 个 build-time 单层 shared fragments 覆盖 58 个消费点,26 exact + 4 near-section 候选全部有 disposition。新增 zero-write materializer、受控 extraction、重复分析、compatibility mirror、validation DAG invariant 与 prepack/package 排除门禁;修复 folded/literal frontmatter 解析和纯 `>`/`|` intent false-green,83 active intent 全部重生并通过 semantic quality。

0 commit comments

Comments
 (0)