@agentic15.com/agentic15-claude-zen 4.2.3 → 5.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 CHANGED
@@ -9,15 +9,38 @@
9
9
 
10
10
  ## Overview
11
11
 
12
+ <table>
13
+ <tr>
14
+ <td width="50%">
15
+
16
+ ### What is Agentic15 Claude Zen?
17
+
12
18
  Agentic15 Claude Zen is a structured development framework designed to work seamlessly with Claude Code. It provides task tracking, workflow structure, and GitHub integration without enforcing rigid testing requirements.
13
19
 
14
20
  **Philosophy:** Structure, not enforcement. The framework provides commands and organization, while Claude decides when tests are appropriate.
15
21
 
22
+ </td>
23
+ <td width="50%">
24
+
25
+ ### Key Benefits
26
+
27
+ - ✅ **Task tracking** and organization
28
+ - ✅ **Consistent workflow** structure
29
+ - ✅ **GitHub integration** with automated PRs
30
+ - ✅ **Manual UI testing** tools
31
+ - ✅ **Flexible** - no mandatory testing
32
+ - ✅ **Claude Code optimized** hooks
33
+
34
+ </td>
35
+ </tr>
36
+ </table>
37
+
16
38
  ---
17
39
 
18
40
  ## Quick Start
19
41
 
20
42
  ### 1. Create Project
43
+ Creates new project with framework structure
21
44
 
22
45
  **Bash/Mac/Linux:**
23
46
  ```bash
@@ -31,30 +54,65 @@ npx "@agentic15.com/agentic15-claude-zen" my-project
31
54
  cd my-project
32
55
  ```
33
56
 
34
- ### 2. Initialize Git and Link to GitHub
57
+ ---
58
+
59
+ ### 2. Initialize Git
60
+ Links project to GitHub (required for PRs)
35
61
 
36
62
  ```bash
37
- # Initialize git repository
38
63
  git init
39
64
  git branch -M main
40
65
  git add .
41
66
  git commit -m "Initial commit"
42
67
 
43
- # Create GitHub repository and link it
44
68
  gh repo create OWNER/REPO --public
45
69
  git remote add origin https://github.com/OWNER/REPO.git
46
70
  git push -u origin main
47
71
  ```
48
72
 
49
- > **Note:** Replace `OWNER/REPO` with your GitHub username and repository name (e.g., `myusername/my-project`).
73
+ **Note:** Replace `OWNER/REPO` with your GitHub username/repo
74
+
75
+ ---
76
+
77
+ ### 3. Configure Auth
78
+ One-time GitHub authentication setup
79
+
80
+ ```bash
81
+ npx agentic15 auth
82
+ ```
83
+
84
+ ---
85
+
86
+ ### 4. Create Plan
87
+ Generates and locks project plan
50
88
 
51
- > **Required:** This step is mandatory. The framework needs a GitHub remote to create issues and pull requests.
89
+ **In Terminal:**
90
+ ```bash
91
+ npx agentic15 plan "Build a todo app with add, remove, and list features"
92
+ ```
52
93
 
53
- ### 3. Configure Repository Settings (Optional)
94
+ **In Claude Code (launch from project directory):**
95
+ ```
96
+ Ask: "Create the project plan from the requirements file"
97
+ ```
98
+
99
+ **Back in Terminal:**
100
+ ```bash
101
+ npx agentic15 plan
102
+ git add .
103
+ git commit -m "Add initial project plan"
104
+ git push
105
+ ```
106
+
107
+ **Important:** Commit plan to main BEFORE enabling branch protection
108
+
109
+ ---
110
+
111
+ ### 5. Enable Branch Protection
112
+ Enforces PR-only workflow for all future changes
54
113
 
55
114
  **Bash/Mac/Linux:**
56
115
  ```bash
57
- # Prevent direct pushes to main - require PRs for all changes
58
116
  cat > /tmp/protection.json << 'EOF'
59
117
  {
60
118
  "required_pull_request_reviews": {
@@ -72,7 +130,6 @@ gh api repos/OWNER/REPO/branches/main/protection -X PUT \
72
130
  -H "Accept: application/vnd.github+json" \
73
131
  --input /tmp/protection.json
74
132
 
75
- # Auto-delete branches after PR merge
76
133
  gh api repos/OWNER/REPO -X PATCH \
77
134
  -H "Accept: application/vnd.github+json" \
78
135
  -f delete_branch_on_merge=true
@@ -80,7 +137,6 @@ gh api repos/OWNER/REPO -X PATCH \
80
137
 
81
138
  **PowerShell (Windows):**
82
139
  ```powershell
83
- # Prevent direct pushes to main - require PRs for all changes
84
140
  $body = @"
85
141
  {
86
142
  "required_pull_request_reviews": {
@@ -96,53 +152,64 @@ $body = @"
96
152
 
97
153
  echo $body | gh api repos/OWNER/REPO/branches/main/protection -X PUT -H "Accept: application/vnd.github+json" --input -
98
154
 
99
- # Auto-delete branches after PR merge
100
155
  gh api repos/OWNER/REPO -X PATCH -H "Accept: application/vnd.github+json" -f delete_branch_on_merge=true
101
156
  ```
102
157
 
103
- ### 4. Start Using the Framework
104
-
105
- ```bash
106
- # Configure GitHub authentication (one-time setup)
107
- npx agentic15 auth
158
+ ---
108
159
 
109
- # Create a project plan
110
- npx agentic15 plan "Build a todo app with add, remove, and list features"
160
+ ### 6. Start First Task
161
+ Creates feature branch for first task
111
162
 
112
- # Start the first task
163
+ ```bash
113
164
  npx agentic15 task next
114
165
  ```
115
166
 
116
- ### 5. Development Workflow
167
+ ---
168
+
169
+ ## Daily Development Workflow
117
170
 
118
- **In Claude Code Terminal:**
119
- 1. Ask Claude: "Implement the active task"
120
- 2. Claude writes code in `Agent/` directory
171
+ ### 1. Implement (Claude Code)
172
+ Ask: "Implement the active task"
173
+
174
+ Claude writes code in `Agent/` directory
175
+
176
+ ---
121
177
 
122
- **In Your Terminal:**
178
+ ### 2. Commit & PR (Your Terminal)
123
179
  ```bash
124
- # When task is complete
125
180
  npx agentic15 commit
126
- # This will: stage changes, commit, push, and create PR
127
181
  ```
128
182
 
129
- **On GitHub:**
130
- 1. Review and merge the PR
183
+ Stages changes, commits, pushes, creates PR
184
+
185
+ ---
186
+
187
+ ### 3. Review (GitHub)
188
+ Review and merge the PR
189
+
190
+ ---
131
191
 
132
- **Back in Your Terminal:**
192
+ ### 4. Sync & Next (Your Terminal)
133
193
  ```bash
134
- # Sync with main branch after PR merge
135
194
  npx agentic15 sync
136
- # This will: switch to main, pull changes, delete feature branch
195
+ ```
196
+
197
+ Syncs with main, deletes feature branch
137
198
 
138
- # Continue to next task
199
+ ```bash
139
200
  npx agentic15 task next
140
201
  ```
141
202
 
203
+ Starts next task
204
+
142
205
  ---
143
206
 
144
207
  ## Core Features
145
208
 
209
+ <table>
210
+ <tr>
211
+ <td width="50%">
212
+
146
213
  ### Commands
147
214
 
148
215
  | Command | Description |
@@ -154,9 +221,11 @@ npx agentic15 task next
154
221
  | `npx agentic15 commit` | Commit, push, and create PR |
155
222
  | `npx agentic15 sync` | Sync with main branch after PR merge |
156
223
  | `npx agentic15 visual-test <url>` | Capture UI screenshots and console errors |
157
- | `npx agentic15 upgrade` | Update framework files |
158
224
  | `npx agentic15 auth` | Configure GitHub authentication |
159
225
 
226
+ </td>
227
+ <td width="50%">
228
+
160
229
  ### Workflow Automation
161
230
 
162
231
  The framework automates:
@@ -172,71 +241,158 @@ The framework automates:
172
241
  plan → task → code → commit → PR → merge → sync → next task
173
242
  ```
174
243
 
244
+ </td>
245
+ </tr>
246
+ </table>
247
+
175
248
  ---
176
249
 
177
250
  ## Project Structure
178
251
 
252
+ <table>
253
+ <tr>
254
+ <td width="50%">
255
+
256
+ ### Directory Layout
257
+
179
258
  ```
180
259
  my-project/
181
- ├── .claude/ # Framework configuration
182
- ├── hooks/ # Claude Code hooks
183
- ├── plans/ # Project plans and tasks
184
- ├── settings.json # Framework settings
185
- └── settings.local.json # Local overrides (gitignored)
260
+ ├── node_modules/
261
+ └── @agentic15.com/agentic15-claude-zen/
262
+ └── framework/ # Framework files
263
+ ├── hooks/ # Claude Code hooks
264
+ ├── settings.json # Framework settings
265
+ │ ├── PLAN-SCHEMA.json
266
+ │ ├── PROJECT-PLAN-TEMPLATE.json
267
+ │ └── POST-INSTALL.md
268
+ ├── .claude/ # User-generated content
269
+ │ ├── ACTIVE-PLAN # Current active plan
270
+ │ ├── plans/ # Your project plans
271
+ │ │ └── {planId}/
272
+ │ │ ├── TASK-TRACKER.json
273
+ │ │ └── tasks/
274
+ │ ├── settings.json # References framework
275
+ │ └── settings.local.json # Local overrides
186
276
  ├── Agent/ # Your code workspace
187
277
  │ ├── src/ # Source code
188
278
  │ └── tests/ # Tests (optional)
189
- ├── scripts/ # Build and utility scripts
279
+ ├── scripts/ # Build utilities
190
280
  └── package.json # Project dependencies
191
281
  ```
192
282
 
283
+ </td>
284
+ <td width="50%">
285
+
286
+ ### Framework Upgrades
287
+
288
+ Framework files live in `node_modules` and are automatically updated:
289
+
290
+ ```bash
291
+ # Upgrade to latest version
292
+ npm install @agentic15.com/agentic15-claude-zen@latest
293
+
294
+ # Or to a specific version
295
+ npm install @agentic15.com/agentic15-claude-zen@5.0.0
296
+ ```
297
+
298
+ **What gets updated:**
299
+ - ✅ Framework hooks in `node_modules`
300
+ - ✅ Settings schema and templates
301
+ - ✅ CLI commands
302
+
303
+ **What stays unchanged:**
304
+ - ✅ Your code in `Agent/`
305
+ - ✅ Your plans and tasks in `.claude/plans/`
306
+ - ✅ Your local settings in `.claude/settings.local.json`
307
+
308
+ </td>
309
+ </tr>
310
+ </table>
311
+
193
312
  ---
194
313
 
195
314
  ## GitHub Integration
196
315
 
197
- ### Optional Configuration
316
+ <table>
317
+ <tr>
318
+ <td width="50%">
319
+
320
+ ### Authentication
321
+
322
+ The framework uses **GitHub CLI (`gh`)** for authentication - no personal access tokens needed!
323
+
324
+ **Setup:**
325
+ ```bash
326
+ npx agentic15 auth
327
+ ```
328
+
329
+ This command will:
330
+ 1. Check if `gh` CLI is installed
331
+ 2. Run `gh auth login` if not already authenticated
332
+ 3. Auto-detect your repository owner/repo from git remote
333
+ 4. Save configuration to `.claude/settings.local.json`
334
+
335
+ **Note:** Authentication is handled by `gh` CLI - no token field needed.
336
+
337
+ </td>
338
+ <td width="50%">
339
+
340
+ ### Manual Configuration (Optional)
198
341
 
199
- Create `.claude/settings.local.json`:
342
+ If you need to override the auto-detected values, create or edit `.claude/settings.local.json`:
200
343
  ```json
201
344
  {
202
345
  "github": {
203
- "token": "ghp_xxxxxxxxxxxxx",
346
+ "enabled": true,
347
+ "autoCreate": false,
348
+ "autoUpdate": false,
349
+ "autoClose": false,
204
350
  "owner": "your-username",
205
351
  "repo": "your-repo"
206
352
  }
207
353
  }
208
354
  ```
209
355
 
210
- Or use environment variables:
211
- ```bash
212
- export GITHUB_TOKEN="ghp_xxxxxxxxxxxxx"
213
- export GITHUB_OWNER="your-username"
214
- export GITHUB_REPO="your-repo"
215
- ```
356
+ **Note:** Default settings have `autoCreate`, `autoUpdate`, and `autoClose` set to `false` to give you full control. Set them to `true` if you want automatic GitHub issue management.
357
+
358
+ ### Features (Optional - Enable in settings)
359
+ - **Auto-create issues:** When starting tasks (set `autoCreate: true`)
360
+ - **Auto-update issues:** When creating PRs (set `autoUpdate: true`)
361
+ - **Auto-close issues:** When merging to main (set `autoClose: true`)
362
+ - **Secure authentication:** Uses `gh` CLI credentials
216
363
 
217
- ### Features
218
- - **Auto-create issues:** When starting tasks
219
- - **Auto-update issues:** When creating PRs
220
- - **Auto-close issues:** When merging to main (optional)
364
+ </td>
365
+ </tr>
366
+ </table>
221
367
 
222
368
  ---
223
369
 
224
- ## Requirements
370
+ ## Requirements & Philosophy
371
+
372
+ <table>
373
+ <tr>
374
+ <td width="50%">
375
+
376
+ ### Requirements
225
377
 
226
378
  - **Node.js:** 18.0.0 or higher
227
379
  - **Git:** Any recent version
228
380
  - **GitHub CLI:** `gh` command-line tool
229
381
  - **GitHub Account:** For issue and PR management
230
382
 
231
- ---
232
-
233
- ## Documentation
383
+ ### Documentation
234
384
 
235
385
  - **[CHANGELOG.md](CHANGELOG.md)** - Version history and release notes
236
386
 
237
- ---
387
+ ### Support
388
+
389
+ - **Issues:** https://github.com/agentic15/claude-zen/issues
390
+ - **Documentation:** https://github.com/agentic15/claude-zen
391
+
392
+ </td>
393
+ <td width="50%">
238
394
 
239
- ## Philosophy
395
+ ### Philosophy
240
396
 
241
397
  **Structure, Not Enforcement**
242
398
 
@@ -254,12 +410,9 @@ The framework does NOT enforce:
254
410
 
255
411
  **You decide:** When to write tests, what tools to use, and how to ensure quality. The framework provides structure and tools, not rigid rules.
256
412
 
257
- ---
258
-
259
- ## Support
260
-
261
- - **Issues:** https://github.com/agentic15/claude-zen/issues
262
- - **Documentation:** https://github.com/agentic15/claude-zen
413
+ </td>
414
+ </tr>
415
+ </table>
263
416
 
264
417
  ---
265
418
 
package/bin/agentic15.js CHANGED
@@ -6,7 +6,6 @@ import { TaskCommand } from '../src/cli/TaskCommand.js';
6
6
  import { CommitCommand } from '../src/cli/CommitCommand.js';
7
7
  import { StatusCommand } from '../src/cli/StatusCommand.js';
8
8
  import { PlanCommand } from '../src/cli/PlanCommand.js';
9
- import { UpgradeCommand } from '../src/cli/UpgradeCommand.js';
10
9
  import { VisualTestCommand } from '../src/cli/VisualTestCommand.js';
11
10
  import { SyncCommand } from '../src/cli/SyncCommand.js';
12
11
 
@@ -50,12 +49,6 @@ program
50
49
  .argument('[description]', 'Project description (required for first run)')
51
50
  .action((description) => PlanCommand.handle(description));
52
51
 
53
- // Upgrade framework
54
- program
55
- .command('upgrade')
56
- .description('Upgrade framework files to latest version')
57
- .action(() => UpgradeCommand.execute());
58
-
59
52
  // Visual testing - capture screenshots and console errors
60
53
  program
61
54
  .command('visual-test')