Skip to content

Commit b21ff62

Browse files
committed
docs: make install path obvious
1 parent 9563c47 commit b21ff62

9 files changed

Lines changed: 74 additions & 120 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## 0.2.3 — 2026-06-05
4+
5+
- Moved the install command into the README first screen so GitHub visitors see it immediately.
6+
- Rebuilt the demo GIF and storyboard SVG so the first frame shows `npm install -g codex-flow` and no terminal lines are clipped.
7+
38
## 0.2.2 — 2026-06-05
49

510
- Published `codex-flow` on npm and made npm install the primary public path.

README.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,49 +9,46 @@
99

1010
Turn one natural-language request in Codex App or Codex CLI into **parallel, resumable, journaled Codex sub-agents**.
1111

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
1313

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+
```
1520

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:
2022

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`.
2229

2330
## What it feels like
2431

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

2734
The important difference is not another config file. It is the loop:
2835

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.
3341

3442
Prefer a static version? See the [storyboard SVG](assets/codex-flow-demo.svg).
3543

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
4645

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:
5147

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.
5552

5653
Codex (via the installed skill) will:
5754

@@ -64,6 +61,8 @@ It uses **your Codex / ChatGPT membership login** — no OpenAI API key needed.
6461

6562
If the run is interrupted (Ctrl-C, crash, budget), running it again **resumes**: finished work replays instantly, only unfinished nodes call Codex again.
6663

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+
6766
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.
6867

6968
## Why this is more than "an engine"

assets/codex-flow-demo.gif

-383 KB
Loading

assets/codex-flow-demo.svg

Lines changed: 36 additions & 86 deletions
Loading

docs/CODEX_FOR_OSS_APPLICATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ OpenAI says the program is for maintainers of active public OSS projects with me
1414
## Current readiness
1515

1616
- Public GitHub repository.
17-
- Public release: https://github.com/Dmatut7/codex-flow/releases/tag/v0.2.2
17+
- Public release: https://github.com/Dmatut7/codex-flow/releases/tag/v0.2.3
1818
- MIT license.
1919
- Clear README with install and usage path.
2020
- CLI install path: `npm install -g codex-flow`. GitHub fallback: `npm install -g github:Dmatut7/codex-flow`.

engine/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import { aggregateKeys, makeScope, type EngineRuntime, type Scope } from "./runt
1515
import { createAdapters, resolveBackend as resolveBackendFromRegistry } from "../adapters/registry.ts";
1616
import type { AgentAdapter, NormalizedAgentOpts, NormalizedSchema } from "../adapters/types.ts";
1717

18-
const DEFAULT_ENGINE_VERSION = "0.2.2";
18+
const DEFAULT_ENGINE_VERSION = "0.2.3";
1919

2020
class WorkflowEngine implements Engine, EngineRuntime {
2121
readonly config: Required<Pick<EngineConfig, "defaultBackend" | "autoRoute" | "seed" | "estimatedTokensPerCall" | "engineVersion">> & EngineConfig;

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "codex-flow",
3-
"version": "0.2.2",
3+
"version": "0.2.3",
44
"description": "Dynamic workflow orchestration for Codex — split complex tasks into parallel, resumable, journaled Codex sub-agents.",
55
"type": "module",
66
"license": "MIT",

tests/engine.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ describe("dynamic workflow engine", () => {
5555
}).run(async ({ agent }) => agent("version", { backend: "fake" }));
5656

5757
const [manifest] = await readJsonl(journalPath);
58-
assert.equal(manifest.engineVersion, "0.2.2");
58+
assert.equal(manifest.engineVersion, "0.2.3");
5959
await rm(dir, { recursive: true, force: true });
6060
});
6161

0 commit comments

Comments
 (0)