aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 0c4927a332eb7bfb52287eca2e2e877d8fca2b9d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# Claude Flow

A document-centric coding assistant that enforces a structured workflow: **Research → Plan → Implement**.

Built with Electron, React, and the Claude Agent SDK.

## Workflow

1. **Research** — Claude analyzes your codebase, writes findings to session `research.md`
2. **Plan** — Claude creates an implementation plan with code snippets and TODO checklist
3. **Implement** — Claude executes the plan, committing as it goes

At each phase, edit the document to add notes (`// REVIEW:`, `// NOTE:`), click **Review** for feedback, then **Submit** to advance.

## Git Integration

Each session creates an isolated git worktree:

```
.claude-flow/
├── sessions/{sessionId}/
│   ├── research.md        # Session-specific research
│   └── plan.md            # Session-specific plan
└── worktrees/{sessionId}/ # Git worktree (branch: claude-flow/{sessionId})
```

- Concurrent sessions supported — each has its own branch
- Implementation commits incrementally
- Review in worktree, then merge or discard

## Setup

```bash
npm install
export ANTHROPIC_API_KEY=your-key
npm run dev
```

## Keyboard Shortcuts

- **Cmd/Ctrl + Enter** — Submit
- **Escape** — Interrupt

## References

- [How I Use Claude Code](https://boristane.com/blog/how-i-use-claude-code/) — Boris Tane's post that inspired this workflow

## License

MIT