Skip to content

Commit 79b380c

Browse files
committed
feat: establish public product expression and docs site
1 parent 890b61e commit 79b380c

42 files changed

Lines changed: 5458 additions & 82 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/pages.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Public docs Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'public-site/**'
8+
- 'public-product-expression.json'
9+
- '.github/workflows/pages.yml'
10+
pull_request:
11+
paths:
12+
- 'public-site/**'
13+
- 'public-product-expression.json'
14+
- '.github/workflows/pages.yml'
15+
workflow_dispatch:
16+
17+
concurrency:
18+
group: pages
19+
cancel-in-progress: false
20+
21+
permissions:
22+
contents: read
23+
24+
jobs:
25+
build:
26+
runs-on: ubuntu-latest
27+
steps:
28+
- name: Checkout
29+
uses: actions/checkout@v4
30+
31+
- name: Setup Node
32+
uses: actions/setup-node@v4
33+
with:
34+
node-version: 24.17.0
35+
cache: npm
36+
cache-dependency-path: public-site/package-lock.json
37+
38+
- name: Install public-site dependencies
39+
run: npm --prefix public-site ci
40+
41+
- name: Build public-site
42+
run: npm --prefix public-site run build
43+
44+
- name: Verify generated links
45+
run: node scripts/check-generated-site-links.js --root public-site/doc_build --base /devcodex/
46+
47+
- name: Configure Pages
48+
if: github.event_name != 'pull_request'
49+
uses: actions/configure-pages@v5
50+
51+
- name: Upload Pages artifact
52+
if: github.event_name != 'pull_request'
53+
uses: actions/upload-pages-artifact@v3
54+
with:
55+
path: public-site/doc_build
56+
57+
deploy:
58+
if: github.event_name != 'pull_request' && (github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main')
59+
needs: build
60+
runs-on: ubuntu-latest
61+
permissions:
62+
pages: write
63+
id-token: write
64+
environment:
65+
name: github-pages
66+
url: ${{ steps.deployment.outputs.page_url }}
67+
steps:
68+
- name: Deploy to GitHub Pages
69+
id: deployment
70+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ node_modules/
77
.vscode/
88
dist/
99
coverage/
10+
/public-site/doc_build/
1011
*.log
1112
.env
1213
.env.local

‎README.md‎

Lines changed: 102 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,37 @@
1-
# DevCodex
1+
# DevCodex — 意图驱动的 AI Coding 工作流运行时
22

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

5-
DevCodex 是面向 AI 编程宿主的工作流运行时和宿主适配包。它通过一个 npm 全局包,把上下文、记忆、80+ 内置 Skill、报告与验证闭环接入 Codex、Claude Code、GitHub Copilot、Gemini CLI、Grok 和 Cursor(Beta),让不同宿主在同一个项目里按更一致的开发流程协作。
5+
> **让 AI 编程从一次性聊天,变成可验证、可续接的工程流程。**
66
7-
如果你经常遇到 AI 新会话忘记项目背景、长任务中途断线、不同宿主规则不一致、修复过程没有记录、验证结果说不清这些问题,DevCodex 的目标就是把“随口聊天式开发”变成有上下文、有流程、有记录、可继续的 AI 编程协作。
7+
DevCodex 是面向 Codex、Claude Code、GitHub Copilot、Gemini CLI、Grok 和 Cursor 的意图驱动 AI Coding 工作流运行时。它先识别任务目的、目标项目和风险,再按需加载项目 Profile、上下文、记忆和专业 Skill,并把确认、执行、验证、报告与任务续接组织成一套共享工作流模型。
8+
9+
本地优先、文件支撑的控制层与六宿主适配包,把项目上下文、专业 Skill、确认、验证和报告闭环带入多个 AI Coding 宿主。作为工作流运行时和宿主适配包,它负责协调工程流程,不负责托管模型。
10+
11+
它把三件对真实工程最重要的事放在同一条用户路径里:
12+
13+
- 按任务意图选择工作流、上下文与专业 Skill
14+
- 把需求、确认、实现、验证、报告和续接形成可追踪闭环
15+
- 在六个 AI Coding 宿主间保持一致流程,同时诚实保留能力差异
816

917
```bash
1018
npm install -g devcodex
19+
cd <你的项目根目录>
20+
devcodex init
21+
devcodex status
1122
devcodex --version
1223
```
1324

1425
安装或更新后,先在目标项目或工作区完成下方初始化与状态检查,再完全退出并重新打开宿主的新会话。
1526

16-
DevCodex 不替代业务框架、GitHub CI、安全审计或人工评审。它也不接管 Codex、Claude Code 等宿主原有的个人 Skill、项目指令或配置文件。
27+
### DevCodex 不是什么
28+
29+
- 它不是模型网关,不代理或托管模型调用。
30+
- 它不是通用 Agent 框架,也不是多 Agent 编排器。
31+
- 它不替代业务框架、GitHub CI、安全审计或人工评审。
32+
- 它不保证六个宿主拥有完全相同的 Hook、MCP、插件、权限或生命周期事件。
33+
34+
“本地优先”只描述 DevCodex 的工作流状态、Profile、报告、记忆和项目 Skill 以本地文件保存;普通使用不需要额外后台服务。模型执行和数据处理仍遵循所选 AI Coding 宿主的规则。
1735

1836
## 目录
1937

@@ -23,8 +41,10 @@ DevCodex 不替代业务框架、GitHub CI、安全审计或人工评审。它
2341
- [它如何工作?](#它如何工作)
2442
- [适合谁?](#适合谁)
2543
- [5 分钟开始](#5-分钟开始)
44+
- [安装会改变什么](#安装会改变什么)
2645
- [项目 Profile](#项目-profile)
2746
- [首次信任提示](#首次信任提示)
47+
- [工作流、Skill 与宿主边界](#工作流skill-与宿主边界)
2848
- [常见任务怎么说](#常见任务怎么说)
2949
- [常见问题与排错](#常见问题与排错)
3050
- [更新](#更新)
@@ -165,6 +185,18 @@ Cursor 当前是第六宿主 Beta。全局安装会写入用户级 `~/.cursor/ho
165185

166186
Cursor 与 Grok 同机安装时,`devcodex grok` 只在它启动的 Grok 子进程中关闭 Grok 对 Cursor Hooks 的兼容导入,避免 Grok 二次解析 `~/.cursor/hooks.json`;Cursor 官方 Hook 配置不会被改写,用户直接运行普通 `grok` 时的兼容偏好也不会被永久修改。
167187

188+
## 安装会改变什么
189+
190+
| 位置 | DevCodex 的行为 |
191+
|------|-----------------|
192+
| 用户 HOME | 安装或刷新 DevCodex 受管的六宿主适配器 |
193+
| 项目或 workspace | 仅在你执行 `devcodex init` 后创建 `.devcodex/` 运行态 |
194+
| 项目源码 | 安装本身不自动修改业务源码 |
195+
| 后台服务 | 普通使用不启动常驻网络服务 |
196+
| 宿主原生 Skill 与配置 | 不扫描、复制、合并、覆盖或删除用户已有资产 |
197+
198+
DevCodex 的文件状态留在本机;模型请求、联网能力和数据处理仍由你选择的 AI Coding 宿主及其配置决定。
199+
168200
## 项目 Profile
169201

170202
普通单项目只需执行 `devcodex init`,无需再运行 Profile 命令。多项目 workspace 中,如果某个子项目需要独立于 workspace 基线的 Profile,可在 workspace 根目录按项目名初始化:
@@ -220,15 +252,15 @@ DevCodex 会按任务意图选择流程和 Skill。普通使用者不需要手
220252

221253
如果当前宿主是 Cursor,请使用安装或更新后重新打开的本地 IDE / CLI 会话;不要把 Cursor Cloud Agent 的 Partial 行为当作本地 Beta 适配器故障。
222254

223-
### 自动推进:`@rocky`
255+
### 自动推进:`@devcodex-auto`
224256

225-
如果你希望 DevCodex 在明确任务范围内自动继续执行,可以在请求里带上 `@rocky`:
257+
如果你希望 DevCodex 在明确任务范围内自动继续执行,公开的 canonical 入口是 `@devcodex-auto`:
226258

227259
```text
228-
@rocky 阅读当前项目,修复失败的 CI,完成后提交。
260+
@devcodex-auto 阅读当前项目,修复失败的 CI,完成后提交。
229261
```
230262

231-
`@rocky` 是全局默认 `@rocky` 自动推进别名。进入自动推进后,DevCodex 会在当前会话里尽量连续完成需求、实现、验证、报告等步骤;如果你想退出,直接说“退出 auto”或“exit auto mode”即可。
263+
`@rocky` 是默认兼容快捷别名,行为与 `@devcodex-auto` 一致。进入自动推进后,DevCodex 会在当前会话里尽量连续完成需求、实现、验证、报告等步骤;如果你想退出,直接说“退出 auto”或“exit auto mode”即可。
232264

233265
自动推进不等于无限授权:删除文件、不可逆操作、越过项目范围、需要外部确认的发布动作等仍会遵守 DevCodex 的安全边界。当前只有 Hook 支持且白名单路径提供 runtime 级硬保证;在只依赖指令回退的宿主中,DevCodex 会尽量按语义继续推进,但不承诺完全等价的自动放行。
234266

@@ -250,7 +282,65 @@ DevCodex 会按任务意图选择流程和 Skill。普通使用者不需要手
250282
}
251283
```
252284

253-
`extensions.devcodex.autoAliases` 用于替换全局默认别名;省略该字段表示继续使用默认 `@rocky`,设置为空数组 `[]` 表示关闭默认自动推进别名。
285+
`extensions.devcodex.autoAliases` 用于替换全局默认快捷别名;非空数组会替换默认 `@rocky`,省略该字段会继续使用它,设置为空数组 `[]` 则关闭默认快捷别名。正式入口 `@devcodex-auto` 不因 Profile 别名配置而改名。
286+
287+
## 工作流、Skill 与宿主边界
288+
289+
<!-- devcodex-public:workflows primary=dev,fix,analyze,audit,resume,chat advanced=self-fix,other -->
290+
<!-- devcodex-public:skills total=86 active=83 gray=3 bucket=80+ -->
291+
<!-- devcodex-public:hosts ids=copilot,claude,codex,gemini,grok,cursor variants=13 -->
292+
<!-- devcodex-public:auto canonical=@devcodex-auto default=@rocky profile-replacement=true empty-array-disables=true -->
293+
294+
### 意图驱动的工作流
295+
296+
用户只需描述目标,DevCodex 会判断任务是需要变更还是只读结论,并选择对应工作流。六个主工作流面向日常使用;两个高级工作流用于治理或兜底,不需要用户平时手动选择。
297+
298+
| 层级 | 工作流 | 适用目的 |
299+
|------|--------|----------|
300+
| 主工作流 | `dev` | 开发或重构功能 |
301+
| 主工作流 | `fix` | 复现、定位并修复问题 |
302+
| 主工作流 | `analyze` | 只读分析与建议 |
303+
| 主工作流 | `audit` | 基于证据的审查 |
304+
| 主工作流 | `resume` | 从项目文件继续既有任务 |
305+
| 主工作流 | `chat` | 不需要项目执行链的交流 |
306+
| 高级工作流 | `self-fix` | 修复 DevCodex 自身治理或流程缺陷 |
307+
| 高级工作流 | `other` | 无法安全归入上述类别的规划兜底 |
308+
309+
`plan` 是阶段或能力,不是第九个 canonical workflow。
310+
311+
### 五个产品支柱
312+
313+
1. **理解任务**:识别用户目的、目标项目、作用域和风险。
314+
2. **加载正确上下文**:按需读取 Profile、项目资料、文件记忆和任务状态。
315+
3. **路由专业能力**:渐进加载当前任务需要的工作流、领域、交付治理或 Workspace Skill。
316+
4. **治理执行**:区分只读与变更流程,管理确认边界并按宿主能力执行。
317+
5. **验证并续接**:记录测试、报告、证据、剩余风险和可恢复的任务状态。
318+
319+
### Skill 如何组织
320+
321+
当前机器事实为 **86 个 Skill(83 active + 3 gray)**;首页使用动态摘要 **80+**,精确数量和生命周期由 Skill portfolio 校验,不由 README 独立维护。
322+
323+
| 类型 | 作用 |
324+
|------|------|
325+
| Workflow Skill | 负责开发、修复、分析、审查等主流程 |
326+
| Domain Skill | 提供架构、安全、数据、前后端、性能等专业判断 |
327+
| Delivery & Governance Skill | 负责测试、文档、发布、报告、质量和流程闭环 |
328+
| Workspace Skill | 保存某个项目或团队自己的流程与知识 |
329+
330+
Rules / `AGENTS.md` 提供项目约束,Skills 提供专业流程和知识,MCP 提供结构化工具与数据访问;DevCodex 根据意图、项目现实和宿主能力协调这些层,并维护工作流状态、确认边界、验证证据与任务续接。它不替代这些层,也不把它们简化成胜负关系。
331+
332+
### 六宿主适配边界
333+
334+
DevCodex 共享一套工作流模型,但执行强度取决于各宿主可用的 Hooks、MCP、插件、权限和生命周期事件。
335+
336+
| 宿主 | 推荐入口 | 公开状态 |
337+
|------|----------|----------|
338+
| GitHub Copilot | Copilot CLI;VS Code / JetBrains 使用 instruction fallback | 入口能力不同,按精确宿主证据执行 |
339+
| Claude Code | Claude Code | Full(以当前 direct evidence 为上限) |
340+
| Codex | Codex App / CLI | Beta(Hook / MCP 取决于宿主配置) |
341+
| Gemini CLI | Gemini CLI | Beta / UNVERIFIED(需要 direct replay 才能升级) |
342+
| Grok | `devcodex grok` | Full launcher;普通 grok 为 Partial |
343+
| Cursor | 本地 IDE / CLI | 本地 Beta;Cloud Partial / UNVERIFIED |
254344

255345
## 常见任务怎么说
256346

@@ -287,7 +377,7 @@ DevCodex 会按任务意图选择流程和 Skill。普通使用者不需要手
287377
### 自动修复并验证
288378

289379
```text
290-
@rocky 修复当前失败的 GitHub CI,检查是否还有同类问题,运行完整验证,完成后提交。
380+
@devcodex-auto 修复当前失败的 GitHub CI,检查是否还有同类问题,运行完整验证,完成后提交。
291381
```
292382

293383
### 深度审查
@@ -313,7 +403,7 @@ DevCodex 会按任务意图选择流程和 Skill。普通使用者不需要手
313403
提交、push、tag、GitHub Release 和 npm publish 都属于独立动作。需要发布时请直接写明:
314404

315405
```text
316-
@rocky 完成修复和全部验证后提交并推送 main,发布新的 patch 版本到 npm 和 GitHub Release,再用线上包重新安装验证。
406+
@devcodex-auto 完成修复和全部验证后提交并推送 main,发布新的 patch 版本到 npm 和 GitHub Release,再用线上包重新安装验证。
317407
```
318408

319409
几个实用技巧:
@@ -322,7 +412,7 @@ DevCodex 会按任务意图选择流程和 Skill。普通使用者不需要手
322412
- 指定项目、目录或文件范围,避免在多项目 workspace 中产生歧义。
323413
- 写明必须运行的测试,或要求 DevCodex 根据影响范围选择验证。
324414
- “完成”不自动等于 commit、push 或发布;这些动作需要在当前请求中明确写出。
325-
- `@rocky` 只负责在已授权范围内自动推进,不会扩大删除、越界访问或发布权限。
415+
- `@devcodex-auto`(以及默认快捷别名 `@rocky`)只负责在已授权范围内自动推进,不会扩大删除、越界访问或发布权限。
326416

327417
## 常见问题与排错
328418

‎changelogs/unreleased.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# 未发布变更(Unreleased)
22

33
> **用途**: 记录尚未正式发版的实现级变更。
4-
> **当前**: v1.17.8 已发布;v1.17.9 已获 `@rocky` 发布授权并处于本地资格验证阶段。远端 tag、npm 与 GitHub Release 完成前仍只属于候选,当前发行事实由 Profile 05 的 `ProfileCurrentTruthV1` 对照 package、workflow、npm 与 GitHub。
4+
> **当前**: v1.17.9 已发布并完成 R7;本文件记录其后的公开产品表达、README 契约与公开站点补丁候选。新 patch 的远端 tag、npm 与 GitHub Release 完成前仍只属于候选,当前发行事实由 Profile 05 的 `ProfileCurrentTruthV1` 对照 package、workflow、npm 与 GitHub。
55
66
## 当前未发布实现候选
77

8+
- **公开产品表达、README V2 与 GitHub Pages 补丁候选**:新增稳定产品语义与动态工作流/Skill/六宿主投影,公共 README 采用意图驱动工作流运行时定位并保留 V1 兼容入口;新增独立 `public-site/` Rspress 站点、PR 构建和 main Pages 发布链,维护者 `website/` 继续不进入公开仓/npm 包。homepage 先使用真实仓库回退,只有 Pages 品牌身份回读 PASS 后才切换;发布后还须验证 GitHub metadata、npm registry、fresh install、本机六宿主与新会话生效。
89
- **v1.17.9 聚合发布候选**:纳入 v1.17.8 发布后已核实的 35 项失败关闭、事务/CAS、workspace temp V2、Memory 与 Profile current-truth 修复;同时修复 Windows Grok 通过 PowerShell 执行受管 Hook 时首个引号可执行文件被解析为字符串而触发 `ParserError`,统一使用可被 `cmd.exe` 与 PowerShell 接受的稳定 Node 启动命令。Grok 用户级全局文件退出 DevCodex lifecycle 声明,六事件由用户级 `devcodex-workspace` plugin 单独拥有;runtime verifier 分别核对物理声明、Grok 精确去重后的有效 handler 与 mutation owner。Grok 默认导入 DevCodex Claude Hook 时,稳定 launcher 依据四项 Grok 保留环境指纹在回执读取前静默退出;用户自有 Hook、Grok Claude 兼容偏好、portable 模式与其他五宿主语义不变。完整说明见 `changelogs/releases/v1.17.9.md`。
910
- **v1.17.8 宿主稳定入口与 SkillRoute 自举修复已归档(PI-251~255 / PF-303~307)**:六宿主 Hook 改为稳定 launcher,由 committed receipt 安全转发到当前不可变 runtime,避免每次升级改变 Codex Hook 信任身份;`profile_context_plan` 在宿主没有分发 UserPromptSubmit 时返回并复用精确 SkillRoute bootstrap,并把多项目 pending 的 canonical hostVariant/显式 Skill 保真带入 MCP;ContextRead 对复合 content 选择唯一主 schema,拒绝用 sidecar 覆盖可观察的身份失配;S15 归一化 Hook history 与结构化 receipt,并以 evidence-bound hostVariant 阻止 Desktop ambient 污染 CLI。完整说明见 `changelogs/releases/v1.17.8.md`;正式发布事实以 Git tag、npm registry、GitHub Release 与 `ProfileCurrentTruthV1` 为准。
1011
- **v1.17.7 全局运行态一致性与首次加载闭环修复已归档**:22 项确认问题及 Windows Node 18 插桩递归、验证预算假失败均已关闭;GitHub CI、Publish、npm/GitHub tarball parity 与六宿主本机更新已经完成。完整说明见 `changelogs/releases/v1.17.7.md`。

0 commit comments

Comments
 (0)