@wandoupeas/coding-forge 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +58 -15
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -43,26 +43,29 @@ WebForge 是一个面向 Coding Agent 的 `agent-first harness` 参考实现。
43
43
 
44
44
  ## 快速开始
45
45
 
46
- 先构建 CLI:
46
+ ### 安装方式
47
+
48
+ **方式一:本地源码部署(开发/调试)**
47
49
 
48
50
  ```bash
49
51
  npm install
50
52
  npm run build
53
+ # 使用方式: node dist/cli/index.js <command>
51
54
  ```
52
55
 
53
- 如果你是 npm 使用者,安装方式会是:
56
+ **方式二:npm 全局安装(推荐)**
54
57
 
55
58
  ```bash
56
59
  npm install -g @wandoupeas/coding-forge
57
- ```
60
+ # 使用方式: webforge <command>
58
61
 
59
- 或者直接临时运行:
60
-
61
- ```bash
62
+ # 或临时运行
62
63
  npx @wandoupeas/coding-forge --help
63
64
  ```
64
65
 
65
- 然后初始化一个新仓库:
66
+ ### 初始化仓库
67
+
68
+ 以下命令以**本地源码**方式演示,如果你使用 npm 安装,请将 `node dist/cli/index.js` 替换为 `webforge`:
66
69
 
67
70
  ```bash
68
71
  node dist/cli/index.js init demo-app
@@ -78,14 +81,23 @@ node dist/cli/index.js init demo-app
78
81
  初始化完成后,进入新仓库先运行:
79
82
 
80
83
  ```bash
84
+ # 本地源码方式
81
85
  node dist/cli/index.js doctor
86
+
87
+ # 或 npm 安装方式
88
+ webforge doctor
82
89
  ```
83
90
 
84
91
  如果你希望让正在仓库里工作的 agent 直接消费结构化状态,可以使用:
85
92
 
86
93
  ```bash
94
+ # 本地源码方式
87
95
  node dist/cli/index.js doctor --json
88
96
  node dist/cli/index.js resume --json
97
+
98
+ # 或 npm 安装方式
99
+ webforge doctor --json
100
+ webforge resume --json
89
101
  ```
90
102
 
91
103
  这两个命令分别回答:
@@ -96,12 +108,10 @@ node dist/cli/index.js resume --json
96
108
  如果你想用本地 Web UI 统一查看多个 WebForge 项目,可以直接启动:
97
109
 
98
110
  ```bash
111
+ # 本地源码方式
99
112
  node dist/cli/index.js ui --root ~/projects
100
- ```
101
-
102
- 如果你已经通过 npm 安装,则等价命令是:
103
113
 
104
- ```bash
114
+ # 或 npm 安装方式
105
115
  webforge ui --root ~/projects
106
116
  ```
107
117
 
@@ -128,14 +138,12 @@ webforge ui --root ~/projects
128
138
  推荐最短使用路径:
129
139
 
130
140
  ```bash
141
+ # 本地源码方式
131
142
  node dist/cli/index.js init demo-app
132
143
  cd demo-app
133
144
  node /path/to/work-forge/dist/cli/index.js onboard --json
134
- ```
135
-
136
- 如果你已经通过 npm 安装,则等价命令是:
137
145
 
138
- ```bash
146
+ # 或 npm 安装方式
139
147
  webforge init demo-app
140
148
  cd demo-app
141
149
  webforge onboard --json
@@ -251,22 +259,37 @@ WebForge 和 `superpowers` 不是互相替代的关系:
251
259
  如果你是人类开发者在仓库里工作,推荐顺序是:
252
260
 
253
261
  ```bash
262
+ # 本地源码方式
254
263
  node dist/cli/index.js doctor
255
264
  node dist/cli/index.js resume
256
265
  node dist/cli/index.js dashboard
266
+
267
+ # 或 npm 安装方式
268
+ webforge doctor
269
+ webforge resume
270
+ webforge dashboard
257
271
  ```
258
272
 
259
273
  如果你是希望让 agent 直接消费仓库状态,推荐顺序是:
260
274
 
261
275
  ```bash
276
+ # 本地源码方式
262
277
  node dist/cli/index.js onboard --json
278
+
279
+ # 或 npm 安装方式
280
+ webforge onboard --json
263
281
  ```
264
282
 
265
283
  或者显式拆开:
266
284
 
267
285
  ```bash
286
+ # 本地源码方式
268
287
  node dist/cli/index.js doctor --json
269
288
  node dist/cli/index.js resume --json
289
+
290
+ # 或 npm 安装方式
291
+ webforge doctor --json
292
+ webforge resume --json
270
293
  ```
271
294
 
272
295
  标准含义:
@@ -316,26 +339,46 @@ node dist/cli/index.js resume --json
316
339
  npm run test:unit
317
340
  npm run build
318
341
  npm run smoke:onboarding
342
+
343
+ # 本地源码方式
319
344
  node dist/cli/index.js --help
320
345
  node dist/cli/index.js doctor
346
+
347
+ # 或 npm 安装方式
348
+ webforge --help
349
+ webforge doctor
321
350
  ```
322
351
 
323
352
  常用结构化观察命令:
324
353
 
325
354
  ```bash
355
+ # 本地源码方式
326
356
  node dist/cli/index.js onboard --json
327
357
  node dist/cli/index.js doctor --json
328
358
  node dist/cli/index.js resume --json
329
359
  node dist/cli/index.js logs runtime --json
360
+
361
+ # 或 npm 安装方式
362
+ webforge onboard --json
363
+ webforge doctor --json
364
+ webforge resume --json
365
+ webforge logs runtime --json
330
366
  ```
331
367
 
332
368
  常用 workflow 回写命令:
333
369
 
334
370
  ```bash
371
+ # 本地源码方式
335
372
  node dist/cli/index.js superpowers record writing-plans \
336
373
  --summary "approved spec converted into execution plan" \
337
374
  --artifact plan:docs/superpowers/plans/demo-plan.md \
338
375
  --task T001
376
+
377
+ # 或 npm 安装方式
378
+ webforge superpowers record writing-plans \
379
+ --summary "approved spec converted into execution plan" \
380
+ --artifact plan:docs/superpowers/plans/demo-plan.md \
381
+ --task T001
339
382
  ```
340
383
 
341
384
  ## 项目状态
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wandoupeas/coding-forge",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "Agent-first harness CLI for Codex and Claude Code",
5
5
  "type": "module",
6
6
  "main": "./dist/cli/index.js",