workflow-ledger 0.3.5 → 0.3.8
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.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/README.md +15 -12
- package/README.zh-CN.md +15 -12
- package/bin/workflow-ledger.js +548 -31
- package/docs/cli.md +18 -13
- package/docs/design.md +1 -1
- package/docs/design.zh-CN.md +1 -1
- package/docs/usage.md +12 -9
- package/docs/usage.zh-CN.md +9 -6
- package/examples/claude-project/CLAUDE.md.snippet +3 -2
- package/examples/claude-project/CLAUDE.zh-CN.md.snippet +19 -0
- package/examples/codex-project/AGENTS.md.snippet +1 -0
- package/examples/codex-project/AGENTS.zh-CN.md.snippet +12 -0
- package/install.sh +7 -34
- package/package.json +1 -1
- package/skills/workflow-ledger/SKILL.md +11 -5
- package/skills/workflow-ledger/templates/WORKFLOW.zh-CN.md +50 -0
- package/templates/WORKFLOW.zh-CN.md +50 -0
- package/bin/workflow-ledger +0 -417
package/README.md
CHANGED
|
@@ -94,18 +94,21 @@ npx workflow-ledger setup --tool codex
|
|
|
94
94
|
npx workflow-ledger setup --tool all
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
`setup` only installs the integration so supported agents can find it. It does not activate Workflow Ledger in every project.
|
|
98
|
+
|
|
99
|
+
Then initialize a project ledger from the target project root. Bare `init` asks you to choose a language first; automation can pass `--lang en` or `--lang zh-CN` to skip the prompt:
|
|
98
100
|
|
|
99
101
|
```bash
|
|
100
102
|
npx workflow-ledger init
|
|
101
|
-
npx workflow-ledger init --
|
|
102
|
-
npx workflow-ledger init --tool
|
|
103
|
-
npx workflow-ledger init --tool
|
|
103
|
+
npx workflow-ledger init --lang en
|
|
104
|
+
npx workflow-ledger init --tool claude-code --lang en
|
|
105
|
+
npx workflow-ledger init --tool codex --lang en
|
|
106
|
+
npx workflow-ledger init --tool all --lang en
|
|
104
107
|
```
|
|
105
108
|
|
|
106
|
-
`
|
|
109
|
+
`init` is the activation step. It creates project-local ledger files and short instruction snippets. Without `init`, the skill stays dormant for ordinary development work. `claude-code` uses `.claude/WORKFLOW.md`; `codex` uses `.workflow-ledger/WORKFLOW.md` plus `AGENTS.md`. The language choice controls newly created ledger templates and tool instruction snippets; existing files are not overwritten.
|
|
107
110
|
|
|
108
|
-
The Bash installer remains available for Claude Code project initialization:
|
|
111
|
+
The Bash installer remains available for Claude Code project initialization. It uses the Node.js CLI internally, so Node.js 18 or newer is required:
|
|
109
112
|
|
|
110
113
|
```bash
|
|
111
114
|
curl -fsSL https://raw.githubusercontent.com/MorseWayne/workflow-ledger/main/install.sh | bash
|
|
@@ -131,11 +134,11 @@ mkdir -p ~/.claude/skills
|
|
|
131
134
|
cp -R skills/workflow-ledger ~/.claude/skills/workflow-ledger
|
|
132
135
|
```
|
|
133
136
|
|
|
134
|
-
The
|
|
137
|
+
The CLI can check and summarize the ledger:
|
|
135
138
|
|
|
136
139
|
```bash
|
|
137
|
-
|
|
138
|
-
|
|
140
|
+
npx workflow-ledger doctor
|
|
141
|
+
npx workflow-ledger list
|
|
139
142
|
```
|
|
140
143
|
|
|
141
144
|
See [docs/cli.md](docs/cli.md) for command details. The CLI is an optional guardrail; it does not replace the skill workflow.
|
|
@@ -153,7 +156,7 @@ Then invoke it in Claude Code:
|
|
|
153
156
|
A project needs two layers:
|
|
154
157
|
|
|
155
158
|
1. Global tool setup with `workflow-ledger setup` so supported agents can find the workflow instructions.
|
|
156
|
-
2. Project initialization with `workflow-ledger init` so the repository has a ledger file and a short tool-specific reminder.
|
|
159
|
+
2. Project initialization with `workflow-ledger init` so the repository has a ledger file and a short tool-specific reminder. This is what makes Workflow Ledger active for that project.
|
|
157
160
|
|
|
158
161
|
For Claude Code, `init` adds the snippet from [examples/claude-project/CLAUDE.md.snippet](examples/claude-project/CLAUDE.md.snippet) to your project's `CLAUDE.md` and creates [skills/workflow-ledger/templates/WORKFLOW.md](skills/workflow-ledger/templates/WORKFLOW.md) at `.claude/WORKFLOW.md`.
|
|
159
162
|
|
|
@@ -190,7 +193,7 @@ Resume next:
|
|
|
190
193
|
|
|
191
194
|
| Level | Use for | Ledger? |
|
|
192
195
|
|---|---|---|
|
|
193
|
-
| Level 0 | Q&A, read-only explanation | No |
|
|
196
|
+
| Level 0 | Q&A, read-only explanation, tagging or release-version publishing | No |
|
|
194
197
|
| Level 1 | typo, docs tweak, tiny config, no behavior change | Optional |
|
|
195
198
|
| Level 2 | standard code work, tests, single-module behavior changes | Yes |
|
|
196
199
|
| Level 3 | new features, cross-module work, public APIs, unclear or high-risk changes | Yes, attachments optional |
|
|
@@ -223,4 +226,4 @@ Skip it for:
|
|
|
223
226
|
|
|
224
227
|
## Repository status
|
|
225
228
|
|
|
226
|
-
This version
|
|
229
|
+
This version uses the Node.js CLI as the single implementation for setup, init, doctor, list, and hooks. The Bash installer remains as a small bootstrap wrapper for Claude Code project initialization.
|
package/README.zh-CN.md
CHANGED
|
@@ -92,18 +92,21 @@ npx workflow-ledger setup --tool codex
|
|
|
92
92
|
npx workflow-ledger setup --tool all
|
|
93
93
|
```
|
|
94
94
|
|
|
95
|
-
|
|
95
|
+
`setup` 只安装工具接入,让支持的 agent 能找到它;它不会让 Workflow Ledger 在所有项目里自动生效。
|
|
96
|
+
|
|
97
|
+
然后在目标项目根目录初始化 ledger。裸 `init` 会先交互式选择语言;自动化脚本可传 `--lang en` 或 `--lang zh-CN` 跳过交互:
|
|
96
98
|
|
|
97
99
|
```bash
|
|
98
100
|
npx workflow-ledger init
|
|
99
|
-
npx workflow-ledger init --
|
|
100
|
-
npx workflow-ledger init --tool
|
|
101
|
-
npx workflow-ledger init --tool
|
|
101
|
+
npx workflow-ledger init --lang zh-CN
|
|
102
|
+
npx workflow-ledger init --tool claude-code --lang zh-CN
|
|
103
|
+
npx workflow-ledger init --tool codex --lang zh-CN
|
|
104
|
+
npx workflow-ledger init --tool all --lang zh-CN
|
|
102
105
|
```
|
|
103
106
|
|
|
104
|
-
`
|
|
107
|
+
`init` 是启用步骤。它创建项目本地 ledger 和短指令片段。没有 `init` 时,本 skill 对普通开发任务保持 dormant。`claude-code` 使用 `.claude/WORKFLOW.md`;`codex` 使用 `.workflow-ledger/WORKFLOW.md` 和 `AGENTS.md`。语言选择会影响新创建的 ledger 模板和工具指令片段;已有文件不会被覆盖。
|
|
105
108
|
|
|
106
|
-
Bash 安装器仍可用于 Claude Code
|
|
109
|
+
Bash 安装器仍可用于 Claude Code 项目初始化。它内部使用 Node.js CLI,因此需要 Node.js 18 或更高版本:
|
|
107
110
|
|
|
108
111
|
```bash
|
|
109
112
|
curl -fsSL https://raw.githubusercontent.com/MorseWayne/workflow-ledger/main/install.sh | bash
|
|
@@ -129,11 +132,11 @@ mkdir -p ~/.claude/skills
|
|
|
129
132
|
cp -R skills/workflow-ledger ~/.claude/skills/workflow-ledger
|
|
130
133
|
```
|
|
131
134
|
|
|
132
|
-
|
|
135
|
+
CLI 可以检查和汇总 ledger:
|
|
133
136
|
|
|
134
137
|
```bash
|
|
135
|
-
|
|
136
|
-
|
|
138
|
+
npx workflow-ledger doctor
|
|
139
|
+
npx workflow-ledger list
|
|
137
140
|
```
|
|
138
141
|
|
|
139
142
|
详见 [docs/cli.md](docs/cli.md)。CLI 是可选保护栏,不替代 skill 工作流。
|
|
@@ -151,7 +154,7 @@ cp -R skills/workflow-ledger ~/.claude/skills/workflow-ledger
|
|
|
151
154
|
项目接入分两层:
|
|
152
155
|
|
|
153
156
|
1. 先用 `workflow-ledger setup` 做全局工具接入,让支持的 agent 能找到工作流指令。
|
|
154
|
-
2. 再用 `workflow-ledger init` 初始化项目,让仓库里有 ledger
|
|
157
|
+
2. 再用 `workflow-ledger init` 初始化项目,让仓库里有 ledger 文件和短工具提醒。这一步才会让 Workflow Ledger 在该项目生效。
|
|
155
158
|
|
|
156
159
|
对 Claude Code,`init` 会把 [examples/claude-project/CLAUDE.md.snippet](examples/claude-project/CLAUDE.md.snippet) 加入项目 `CLAUDE.md`,并把 [skills/workflow-ledger/templates/WORKFLOW.md](skills/workflow-ledger/templates/WORKFLOW.md) 创建到 `.claude/WORKFLOW.md`。
|
|
157
160
|
|
|
@@ -188,7 +191,7 @@ Resume next:
|
|
|
188
191
|
|
|
189
192
|
| Level | 适用场景 | 是否写 ledger |
|
|
190
193
|
|---|---|---|
|
|
191
|
-
| Level 0 |
|
|
194
|
+
| Level 0 | 问答、只读解释、新增 tag 或发布版本 | 不需要 |
|
|
192
195
|
| Level 1 | typo、文档小改、小配置、无行为变化 | 可选 |
|
|
193
196
|
| Level 2 | 标准代码修改、测试、单模块行为变更 | 需要 |
|
|
194
197
|
| Level 3 | 新功能、跨模块、公共 API、不明确或高风险变更 | 需要,可选附件 |
|
|
@@ -221,4 +224,4 @@ Resume next:
|
|
|
221
224
|
|
|
222
225
|
## 当前状态
|
|
223
226
|
|
|
224
|
-
|
|
227
|
+
当前版本以 Node.js CLI 作为 setup、init、doctor、list 和 hooks 的唯一实现。Bash 安装器保留为 Claude Code 项目初始化的轻量 bootstrap wrapper。
|