Skip to content

Commit 052c526

Browse files
committed
docs: clarify skill update flow
1 parent d4c87eb commit 052c526

4 files changed

Lines changed: 56 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
- Added GitHub Actions npm Trusted Publishing workflow so tagged releases can publish without local npm tokens or OTP.
66
- Added maintainer operations docs for releases, Trusted Publishing, and bundled Codex skill updates.
7+
- Clarified that users receive skill updates by reinstalling `codex-flow@latest`, rerunning `codex-flow install-codex`, and restarting Codex.
78

89
## 0.2.4 — 2026-06-05
910

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,20 @@ Then open **any** project in Codex and say:
2727
GitHub fallback if npm is unavailable: `npm install -g github:Dmatut7/codex-flow`.
2828
`dongt` remains as a compatibility alias, but the public package and docs use `codex-flow`.
2929

30+
## Update installed Codex skills
31+
32+
When `codex-flow` ships updated skills, update both the npm package and the copied Codex skills:
33+
34+
```bash
35+
npm install -g codex-flow@latest
36+
codex-flow install-codex
37+
codex-flow doctor
38+
# restart Codex App or Codex CLI
39+
```
40+
41+
Why both steps? `npm install -g` updates the CLI package; `codex-flow install-codex` copies the bundled skills into `~/.codex/skills`.
42+
Codex reads those installed skill files after restart.
43+
3044
## What it feels like
3145

3246
![codex-flow animated demo](assets/codex-flow-demo.gif)

docs/CODEX_APP_CLI.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,20 @@ codex-flow doctor
3333

3434
Restart Codex App or Codex CLI after installing the skill.
3535

36-
## 3. Use it in any project
36+
## 3. Update the installed skills later
37+
38+
If `codex-flow` releases updated skills, users who already installed it should run:
39+
40+
```bash
41+
npm install -g codex-flow@latest
42+
codex-flow install-codex
43+
codex-flow doctor
44+
# restart Codex App or Codex CLI
45+
```
46+
47+
`npm install -g` updates the package. `codex-flow install-codex` is still required because Codex uses copied files under `~/.codex/skills`.
48+
49+
## 4. Use it in any project
3750

3851
Open the target repository in Codex and say one of these:
3952

@@ -52,7 +65,7 @@ Codex should:
5265
3. write `.codex-flow/journal/<task>.jsonl`,
5366
4. summarize the parallel branches and result.
5467

55-
## 4. Resume after interruption
68+
## 5. Resume after interruption
5669

5770
Run the same command again:
5871

@@ -62,23 +75,23 @@ codex-flow run .codex-flow/generated/<task>.workflow.ts
6275

6376
Completed nodes replay from the journal. Only unfinished or changed nodes call Codex again.
6477

65-
## 5. Try without network first
78+
## 6. Try without network first
6679

6780
```bash
6881
codex-flow try
6982
```
7083

7184
`try` creates a starter workflow in the current project and forces the fake backend, so this works without Codex login or network.
7285

73-
## 6. Membership vs API key
86+
## 7. Membership vs API key
7487

7588
Default backend: `codex-sdk`.
7689

7790
That uses your logged-in Codex / ChatGPT account. No OpenAI API key is needed for the default path.
7891

7992
Only the optional `openai-responses` backend needs `OPENAI_API_KEY`.
8093

81-
## 7. If Codex does not start a workflow
94+
## 8. If Codex does not start a workflow
8295

8396
Use a direct trigger phrase:
8497

@@ -101,7 +114,7 @@ codex-flow install-codex
101114

102115
Restart Codex and try again.
103116

104-
## 8. If the workflow fails
117+
## 9. If the workflow fails
105118

106119
Most failures are in the generated workflow, not the engine. Ask Codex to fix the generated file and rerun the same command.
107120

@@ -113,7 +126,7 @@ codex-flow run .codex-flow/generated/<task>.workflow.ts --backend fake
113126
codex-flow smoke --backend codex-sdk
114127
```
115128

116-
## 9. When to use it
129+
## 10. When to use it
117130

118131
Use `codex-flow` for tasks that can be split:
119132

docs/MAINTAINER_OPERATIONS.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,26 @@ npx npm@^11.10.0 trust github codex-flow \
6969
--yes
7070
```
7171

72+
## How users receive updated Codex skills
73+
74+
Important: publishing a new npm version does not automatically rewrite a user's installed Codex skill files.
75+
76+
`codex-flow install-codex` copies the bundled skills from the installed package into the user's Codex home:
77+
78+
- source: global npm package contents
79+
- target: `~/.codex/skills/dynamic-workflow`
80+
- target: `~/.codex/skills/business-defect-audit`
81+
- target: `~/.codex/skills/parallel-fix`
82+
83+
So every user-facing skill update needs two user commands after the npm release:
84+
85+
```bash
86+
npm install -g codex-flow@latest
87+
codex-flow install-codex
88+
```
89+
90+
Then they should restart Codex App or Codex CLI. `codex-flow doctor` can confirm whether the installed skills are present/current.
91+
7292
## Updating Codex skills after someone changes this repo
7393

7494
The bundled skills live in:
@@ -77,7 +97,7 @@ The bundled skills live in:
7797
- `codex-skill-business-audit/` → installs as `business-defect-audit`
7898
- `codex-skill-parallel-fix/` → installs as `parallel-fix`
7999

80-
For users installed from npm:
100+
Short user-facing update instructions:
81101

82102
```bash
83103
npm install -g codex-flow@latest

0 commit comments

Comments
 (0)