You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-28Lines changed: 27 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,49 +9,46 @@
9
9
10
10
Turn one natural-language request in Codex App or Codex CLI into **parallel, resumable, journaled Codex sub-agents**.
11
11
12
-
Instead of asking Codex to do one long linear pass, say “use a dynamic workflow” and let Codex split the task, run branches in parallel, replay completed work after interruption, and summarize the journaled result.
12
+
## Install in 30 seconds
13
13
14
-
Built for maintainers and power users who do repeated multi-file work:
14
+
```bash
15
+
npm install -g codex-flow
16
+
codex-flow install-codex
17
+
codex-flow doctor
18
+
# restart Codex App or Codex CLI
19
+
```
15
20
16
-
-**Bug investigations** — one hypothesis or file group per Codex sub-agent.
17
-
-**PR / code review** — fan out review passes, then merge findings.
18
-
-**Issue triage** — classify, reproduce, and propose next actions in parallel.
19
-
-**Release smoke checks** — run repeatable checks with journaled evidence.
21
+
Then open **any** project in Codex and say:
20
22
21
-
If this is useful, star the repo so more Codex users can find it: [Dmatut7/codex-flow](https://github.com/Dmatut7/codex-flow).
23
+
> 用动态工作流帮我排查登录失败的问题
24
+
>
25
+
> use a dynamic workflow to investigate this bug in parallel
26
+
27
+
GitHub fallback if npm is unavailable: `npm install -g github:Dmatut7/codex-flow`.
28
+
`dongt` remains as a compatibility alias, but the public package and docs use `codex-flow`.
The important difference is not another config file. It is the loop:
28
35
29
-
1. say a normal sentence in Codex,
30
-
2. Codex generates a temporary workflow,
31
-
3.`codex-flow` runs the branches,
32
-
4. the journal makes interruption and rerun cheap.
36
+
1. install once,
37
+
2. say a normal sentence in Codex,
38
+
3. Codex generates a temporary workflow,
39
+
4.`codex-flow` runs the branches in parallel,
40
+
5. the journal makes interruption and rerun cheap.
33
41
34
42
Prefer a static version? See the [storyboard SVG](assets/codex-flow-demo.svg).
35
43
36
-
## 30-second start
37
-
38
-
```bash
39
-
npm install -g codex-flow # installs the `codex-flow` CLI
40
-
codex-flow doctor # checks local install + fake backend
41
-
codex-flow try # creates + runs a starter workflow without network
42
-
codex-flow install-codex # installs the "dynamic-workflow" skill into Codex
43
-
codex-flow doctor # confirms the Codex skill is installed
44
-
# restart Codex
45
-
```
44
+
## Why maintainers use it
46
45
47
-
GitHub fallback if npm is unavailable: `npm install -g github:Dmatut7/codex-flow`.
48
-
`dongt` remains as a compatibility alias, but the public package and docs use `codex-flow`.
49
-
50
-
Then, in **any** project, just tell Codex:
46
+
Built for maintainers and power users who do repeated multi-file work:
51
47
52
-
> 用动态工作流帮我排查登录失败的问题
53
-
>
54
-
> use a dynamic workflow to investigate this bug across these files, in parallel
48
+
-**Bug investigations** — one hypothesis or file group per Codex sub-agent.
49
+
-**PR / code review** — fan out review passes, then merge findings.
50
+
-**Issue triage** — classify, reproduce, and propose next actions in parallel.
51
+
-**Release smoke checks** — run repeatable checks with journaled evidence.
55
52
56
53
Codex (via the installed skill) will:
57
54
@@ -64,6 +61,8 @@ It uses **your Codex / ChatGPT membership login** — no OpenAI API key needed.
64
61
65
62
If the run is interrupted (Ctrl-C, crash, budget), running it again **resumes**: finished work replays instantly, only unfinished nodes call Codex again.
66
63
64
+
If this is useful, star the repo so more Codex users can find it: [Dmatut7/codex-flow](https://github.com/Dmatut7/codex-flow).
65
+
67
66
See [how to use it in Codex App / CLI](docs/CODEX_APP_CLI.md), the [FAQ](docs/FAQ.md), the [prompt gallery](docs/PROMPTS.md) for copy-paste Codex prompts, and the [maintainer workflow gallery](examples/README.md) for import-free runnable bug investigation, PR review, issue triage, and release smoke workflows. See [docs/POSITIONING.md](docs/POSITIONING.md) for what `codex-flow` is / is not, [ROADMAP.md](ROADMAP.md) for public next steps, and [docs/LAUNCH_PLAYBOOK.md](docs/LAUNCH_PLAYBOOK.md) for sharing / launch copy.
0 commit comments