@stilero/bankan 1.0.2 → 1.0.4
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/README.md +76 -76
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src="docs/images/ban_kan_logo_readme.svg" alt="Ban Kan logo" width="520" />
|
|
2
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/ban_kan_logo_readme.svg" alt="Ban Kan logo" width="520" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
# Ban Kan
|
|
@@ -21,7 +21,7 @@ Bring order to parallel AI development without leaving your local workflow.
|
|
|
21
21
|
</p>
|
|
22
22
|
|
|
23
23
|
<p align="center">
|
|
24
|
-
<img src="docs/images/bankan_screenshot.png" alt="Ban Kan dashboard showing backlog, planning, implementation, review, and done columns" width="1200" />
|
|
24
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/bankan_screenshot.png" alt="Ban Kan dashboard showing backlog, planning, implementation, review, and done columns" width="1200" />
|
|
25
25
|
</p>
|
|
26
26
|
|
|
27
27
|
<p align="center">
|
|
@@ -38,6 +38,72 @@ Bring order to parallel AI development without leaving your local workflow.
|
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
41
|
+
## Installation
|
|
42
|
+
|
|
43
|
+
### Run instantly
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npx @stilero/bankan
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Install globally
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
npm install -g @stilero/bankan
|
|
53
|
+
bankan
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Run from source
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
git clone https://github.com/stilero/bankan.git
|
|
60
|
+
cd bankan
|
|
61
|
+
|
|
62
|
+
npm run install:all
|
|
63
|
+
npm run setup
|
|
64
|
+
npm run dev
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Ban Kan starts a local server, opens your browser automatically, and serves the dashboard from the same process.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Requirements
|
|
72
|
+
|
|
73
|
+
- Node.js >= 18
|
|
74
|
+
- git
|
|
75
|
+
- One AI CLI tool:
|
|
76
|
+
- claude
|
|
77
|
+
- codex
|
|
78
|
+
- Native build tools for node-pty
|
|
79
|
+
|
|
80
|
+
macOS: Xcode Command Line Tools
|
|
81
|
+
Linux: build-essential
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Quick Start
|
|
86
|
+
|
|
87
|
+
1. Launch Ban Kan
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
bankan
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
2. Complete the setup wizard
|
|
94
|
+
|
|
95
|
+
3. Add one or more local repositories
|
|
96
|
+
|
|
97
|
+
4. Create a task in the dashboard
|
|
98
|
+
|
|
99
|
+
5. Approve the generated plan
|
|
100
|
+
|
|
101
|
+
6. Watch agents implement and review the change
|
|
102
|
+
|
|
103
|
+
7. Optionally create a pull request
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
41
107
|
## What Is Ban Kan
|
|
42
108
|
|
|
43
109
|
Ban Kan is a **local control center for AI coding agents** that work across real repositories.
|
|
@@ -79,14 +145,14 @@ Each stage has a clear responsibility, and tasks move forward only when the prev
|
|
|
79
145
|
<table>
|
|
80
146
|
<tr>
|
|
81
147
|
<td align="center" width="50%">
|
|
82
|
-
<img src="docs/images/before_claude_windows.png" alt="Four separate Claude Code terminal windows used to coordinate parallel agent work before Ban Kan" width="100%" />
|
|
148
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/before_claude_windows.png" alt="Four separate Claude Code terminal windows used to coordinate parallel agent work before Ban Kan" width="100%" />
|
|
83
149
|
<br />
|
|
84
150
|
<strong>Before Ban Kan</strong>
|
|
85
151
|
<br />
|
|
86
152
|
Managing multiple agents means juggling separate terminal windows and fragmented context.
|
|
87
153
|
</td>
|
|
88
154
|
<td align="center" width="50%">
|
|
89
|
-
<img src="docs/images/bankan_multi_tasks.png" alt="Ban Kan dashboard showing multiple tasks and agent output in one coordinated interface" width="100%" />
|
|
155
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/bankan_multi_tasks.png" alt="Ban Kan dashboard showing multiple tasks and agent output in one coordinated interface" width="100%" />
|
|
90
156
|
<br />
|
|
91
157
|
<strong>With Ban Kan</strong>
|
|
92
158
|
<br />
|
|
@@ -133,7 +199,7 @@ Below is the same task moving through Ban Kan's workflow from creation to comple
|
|
|
133
199
|
### 1. Create the task
|
|
134
200
|
|
|
135
201
|
<p align="center">
|
|
136
|
-
<img src="docs/images/workflow/add_task.png" alt="Ban Kan add task modal used to create the Stripe payments task" />
|
|
202
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/workflow/add_task.png" alt="Ban Kan add task modal used to create the Stripe payments task" />
|
|
137
203
|
</p>
|
|
138
204
|
|
|
139
205
|
The developer creates a task in the dashboard and defines the story to be planned and executed.
|
|
@@ -141,7 +207,7 @@ The developer creates a task in the dashboard and defines the story to be planne
|
|
|
141
207
|
### 2. Planning starts
|
|
142
208
|
|
|
143
209
|
<p align="center">
|
|
144
|
-
<img src="docs/images/workflow/planning_stage_started.png" alt="Ban Kan planning stage showing the Stripe payments task as planning starts" />
|
|
210
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/workflow/planning_stage_started.png" alt="Ban Kan planning stage showing the Stripe payments task as planning starts" />
|
|
145
211
|
</p>
|
|
146
212
|
|
|
147
213
|
The planner agent picks up the task, analyzes the repository, and prepares an implementation plan.
|
|
@@ -149,7 +215,7 @@ The planner agent picks up the task, analyzes the repository, and prepares an im
|
|
|
149
215
|
### 3. Review and approve the plan
|
|
150
216
|
|
|
151
217
|
<p align="center">
|
|
152
|
-
<img src="docs/images/workflow/planning_approve_plan.png" alt="Ban Kan planning stage showing an approval-ready plan for the Stripe payments task" />
|
|
218
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/workflow/planning_approve_plan.png" alt="Ban Kan planning stage showing an approval-ready plan for the Stripe payments task" />
|
|
153
219
|
</p>
|
|
154
220
|
|
|
155
221
|
The generated plan is shown in the dashboard so the developer can approve it before any code is written.
|
|
@@ -157,7 +223,7 @@ The generated plan is shown in the dashboard so the developer can approve it bef
|
|
|
157
223
|
### 4. Implementation runs
|
|
158
224
|
|
|
159
225
|
<p align="center">
|
|
160
|
-
<img src="docs/images/workflow/implementing_task.png" alt="Ban Kan implementation stage showing the Stripe payments task being actively worked on by an agent" />
|
|
226
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/workflow/implementing_task.png" alt="Ban Kan implementation stage showing the Stripe payments task being actively worked on by an agent" />
|
|
161
227
|
</p>
|
|
162
228
|
|
|
163
229
|
After approval, the implementor agent creates its workspace, writes the code, and reports progress live in the UI.
|
|
@@ -165,7 +231,7 @@ After approval, the implementor agent creates its workspace, writes the code, an
|
|
|
165
231
|
### 5. Review stage
|
|
166
232
|
|
|
167
233
|
<p align="center">
|
|
168
|
-
<img src="docs/images/workflow/review_stage.png" alt="Ban Kan review stage showing the Stripe payments task being validated by a reviewer agent" />
|
|
234
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/workflow/review_stage.png" alt="Ban Kan review stage showing the Stripe payments task being validated by a reviewer agent" />
|
|
169
235
|
</p>
|
|
170
236
|
|
|
171
237
|
The reviewer agent validates the implementation, checks for issues, and decides whether the task is ready to move forward.
|
|
@@ -173,7 +239,7 @@ The reviewer agent validates the implementation, checks for issues, and decides
|
|
|
173
239
|
### 6. Done / ready for PR
|
|
174
240
|
|
|
175
241
|
<p align="center">
|
|
176
|
-
<img src="docs/images/workflow/done_stage.png" alt="Ban Kan done stage showing the Stripe payments task completed and ready for pull request creation" />
|
|
242
|
+
<img src="https://raw.githubusercontent.com/stilero/bankan/HEAD/docs/images/workflow/done_stage.png" alt="Ban Kan done stage showing the Stripe payments task completed and ready for pull request creation" />
|
|
177
243
|
</p>
|
|
178
244
|
|
|
179
245
|
Once review passes, the task moves to Done and can be used as the basis for a pull request.
|
|
@@ -182,72 +248,6 @@ Multiple tasks can move through these stages simultaneously with different agent
|
|
|
182
248
|
|
|
183
249
|
---
|
|
184
250
|
|
|
185
|
-
## Installation
|
|
186
|
-
|
|
187
|
-
### Run instantly
|
|
188
|
-
|
|
189
|
-
```bash
|
|
190
|
-
npx @stilero/bankan
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
### Install globally
|
|
194
|
-
|
|
195
|
-
```bash
|
|
196
|
-
npm install -g @stilero/bankan
|
|
197
|
-
bankan
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
### Run from source
|
|
201
|
-
|
|
202
|
-
```bash
|
|
203
|
-
git clone https://github.com/stilero/bankan.git
|
|
204
|
-
cd bankan
|
|
205
|
-
|
|
206
|
-
npm run install:all
|
|
207
|
-
npm run setup
|
|
208
|
-
npm run dev
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
Ban Kan starts a local server, opens your browser automatically, and serves the dashboard from the same process.
|
|
212
|
-
|
|
213
|
-
---
|
|
214
|
-
|
|
215
|
-
## Requirements
|
|
216
|
-
|
|
217
|
-
- Node.js >= 18
|
|
218
|
-
- git
|
|
219
|
-
- One AI CLI tool:
|
|
220
|
-
- claude
|
|
221
|
-
- codex
|
|
222
|
-
- Native build tools for node-pty
|
|
223
|
-
|
|
224
|
-
macOS: Xcode Command Line Tools
|
|
225
|
-
Linux: build-essential
|
|
226
|
-
|
|
227
|
-
---
|
|
228
|
-
|
|
229
|
-
## Quick Start
|
|
230
|
-
|
|
231
|
-
1. Launch Ban Kan
|
|
232
|
-
|
|
233
|
-
```bash
|
|
234
|
-
bankan
|
|
235
|
-
```
|
|
236
|
-
|
|
237
|
-
2. Complete the setup wizard
|
|
238
|
-
|
|
239
|
-
3. Add one or more local repositories
|
|
240
|
-
|
|
241
|
-
4. Create a task in the dashboard
|
|
242
|
-
|
|
243
|
-
5. Approve the generated plan
|
|
244
|
-
|
|
245
|
-
6. Watch agents implement and review the change
|
|
246
|
-
|
|
247
|
-
7. Optionally create a pull request
|
|
248
|
-
|
|
249
|
-
---
|
|
250
|
-
|
|
251
251
|
## How It Works
|
|
252
252
|
|
|
253
253
|
```mermaid
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stilero/bankan",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Run AI coding agents like a Kanban board. Plan, implement, review and ship code using parallel AI agents across your local repositories.",
|
|
6
6
|
"license": "MIT",
|