Skip to content

Commit 1bf1f35

Browse files
committed
docs(README): 更新 update 命令文档,替换 --target 为 --module 和 --exclude
更新命令速查表、重写指定更新章节、补充版本检查功能说明
1 parent b873d68 commit 1bf1f35

1 file changed

Lines changed: 32 additions & 16 deletions

File tree

README.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,8 @@ $env:KONTEXT_LLM_MAX_TOKENS = "16384"
196196
| `kontext validate` | 校验 `.kontext/` 下的 JSON 文件 |
197197
| `kontext update` | 检测代码与物料偏差,确认后调用 LLM 更新 |
198198
| `kontext update --force` | 强制更新所有物料,无视变更检测 |
199-
| `kontext update -t <target>` | 指定更新目标(可多次使用) |
199+
| `kontext update -m <模块路径>` | 只更新指定模块(可多次使用) |
200+
| `kontext update -e <目录>` | 排除指定目录,更新其余物料(可多次使用) |
200201
| `kontext config` | 交互式配置向导 |
201202
| `kontext config set <key> <value>` | 设置配置项 |
202203
| `kontext config get <key>` | 获取配置项 |
@@ -285,33 +286,47 @@ kontext update -f
285286

286287
无视变更检测结果,强制更新所有物料(架构图、全部模块契约、项目清单)。适用于首次迁移或需要全量刷新的场景。
287288

288-
#### 指定目标更新
289+
#### 指定模块更新
289290

290291
```bash
291-
kontext update -t <target>
292+
kontext update -m <模块路径>
292293
```
293294

294-
只更新指定的目标,可多次使用 `-t` 指定多个目标。支持以下目标格式:
295-
296-
| 目标格式 | 说明 |
297-
|---------|------|
298-
| `architecture` | 架构图(`ARCHITECTURE_MAP.json`|
299-
| `manifest` | 项目清单(`PROJECT_MANIFEST.json`|
300-
| `contract:<模块路径>` | 指定模块的契约(如 `contract:internal/config`|
295+
只更新指定模块的契约,可多次使用 `-m` 指定多个模块。使用此参数时,architecture 和 manifest 不会被更新。
301296

302297
示例:
303298

304299
```bash
305-
# 只更新 config 模块契约
306-
kontext update -t contract:internal/config
300+
# 只更新 database 模块契约
301+
kontext update -m internal/database
307302

308-
# 同时更新架构图和项目清单
309-
kontext update -t architecture -t manifest
303+
# 同时更新多个模块契约
304+
kontext update -m internal/api -m internal/core
310305

311-
# 更新多个模块契约
312-
kontext update -t contract:internal/config -t contract:internal/schema
306+
# 强制更新指定模块
307+
kontext update --force -m internal/database
313308
```
314309

310+
#### 排除目录更新
311+
312+
```bash
313+
kontext update -e <目录>
314+
```
315+
316+
排除指定目录下的模块,更新其余物料。可多次使用 `-e` 指定多个排除目录。非契约类型(architecture、manifest)始终保留。
317+
318+
示例:
319+
320+
```bash
321+
# 排除 vendor 目录,更新其余物料
322+
kontext update -e vendor
323+
324+
# 排除多个目录
325+
kontext update -e vendor -e third_party
326+
```
327+
328+
> 注意:`-m``-e` 不能同时使用。
329+
315330
## 最小可用示例
316331

317332
如果你想最快验证一遍:
@@ -381,6 +396,7 @@ kontext validate
381396
- 使用模板系统统一组织 Prompt
382397
- `init --scan` 具备阶段缓存和断点恢复能力
383398
- 生成的上下文制品可被 Claude Code、Codex 等 AI 编程工具直接读取
399+
- 每次运行命令时自动检查版本更新,有新版本时提示升级
384400

385401

386402
## 参考

0 commit comments

Comments
 (0)