@agentic15.com/agentic15-claude-zen 4.2.3 → 5.0.2
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 +78 -136
- package/bin/agentic15.js +0 -7
- package/{templates/.claude → framework}/PLAN-SCHEMA.json +240 -240
- package/{templates/.claude → framework}/PROJECT-PLAN-TEMPLATE.json +223 -223
- package/{templates/.claude → framework}/hooks/enforce-plan-template.js +106 -106
- package/{templates/.claude → framework}/settings.json +4 -5
- package/package.json +2 -2
- package/src/cli/AuthCommand.js +53 -47
- package/src/cli/CommitCommand.js +17 -3
- package/src/cli/VisualTestCommand.js +57 -14
- package/src/core/TemplateManager.js +18 -2
- package/src/cli/UpgradeCommand.js +0 -191
- package/templates/.claude/settings.local.json.example +0 -11
- /package/{templates/.claude → framework}/POST-INSTALL.md +0 -0
- /package/{templates/.claude → framework}/hooks/complete-task.js +0 -0
- /package/{templates/.claude → framework}/hooks/require-active-task.js +0 -0
- /package/{templates/.claude → framework}/hooks/session-start-context.js +0 -0
- /package/{templates/.claude → framework}/hooks/start-task.js +0 -0
package/README.md
CHANGED
|
@@ -17,127 +17,23 @@ Agentic15 Claude Zen is a structured development framework designed to work seam
|
|
|
17
17
|
|
|
18
18
|
## Quick Start
|
|
19
19
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
**Bash/Mac/Linux
|
|
23
|
-
|
|
24
|
-
npx
|
|
25
|
-
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
# Initialize git repository
|
|
38
|
-
git init
|
|
39
|
-
git branch -M main
|
|
40
|
-
git add .
|
|
41
|
-
git commit -m "Initial commit"
|
|
42
|
-
|
|
43
|
-
# Create GitHub repository and link it
|
|
44
|
-
gh repo create OWNER/REPO --public
|
|
45
|
-
git remote add origin https://github.com/OWNER/REPO.git
|
|
46
|
-
git push -u origin main
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
> **Note:** Replace `OWNER/REPO` with your GitHub username and repository name (e.g., `myusername/my-project`).
|
|
50
|
-
|
|
51
|
-
> **Required:** This step is mandatory. The framework needs a GitHub remote to create issues and pull requests.
|
|
52
|
-
|
|
53
|
-
### 3. Configure Repository Settings (Optional)
|
|
54
|
-
|
|
55
|
-
**Bash/Mac/Linux:**
|
|
56
|
-
```bash
|
|
57
|
-
# Prevent direct pushes to main - require PRs for all changes
|
|
58
|
-
cat > /tmp/protection.json << 'EOF'
|
|
59
|
-
{
|
|
60
|
-
"required_pull_request_reviews": {
|
|
61
|
-
"required_approving_review_count": 0
|
|
62
|
-
},
|
|
63
|
-
"enforce_admins": false,
|
|
64
|
-
"allow_force_pushes": false,
|
|
65
|
-
"allow_deletions": false,
|
|
66
|
-
"required_status_checks": null,
|
|
67
|
-
"restrictions": null
|
|
68
|
-
}
|
|
69
|
-
EOF
|
|
70
|
-
|
|
71
|
-
gh api repos/OWNER/REPO/branches/main/protection -X PUT \
|
|
72
|
-
-H "Accept: application/vnd.github+json" \
|
|
73
|
-
--input /tmp/protection.json
|
|
74
|
-
|
|
75
|
-
# Auto-delete branches after PR merge
|
|
76
|
-
gh api repos/OWNER/REPO -X PATCH \
|
|
77
|
-
-H "Accept: application/vnd.github+json" \
|
|
78
|
-
-f delete_branch_on_merge=true
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
**PowerShell (Windows):**
|
|
82
|
-
```powershell
|
|
83
|
-
# Prevent direct pushes to main - require PRs for all changes
|
|
84
|
-
$body = @"
|
|
85
|
-
{
|
|
86
|
-
"required_pull_request_reviews": {
|
|
87
|
-
"required_approving_review_count": 0
|
|
88
|
-
},
|
|
89
|
-
"enforce_admins": false,
|
|
90
|
-
"allow_force_pushes": false,
|
|
91
|
-
"allow_deletions": false,
|
|
92
|
-
"required_status_checks": null,
|
|
93
|
-
"restrictions": null
|
|
94
|
-
}
|
|
95
|
-
"@
|
|
96
|
-
|
|
97
|
-
echo $body | gh api repos/OWNER/REPO/branches/main/protection -X PUT -H "Accept: application/vnd.github+json" --input -
|
|
98
|
-
|
|
99
|
-
# Auto-delete branches after PR merge
|
|
100
|
-
gh api repos/OWNER/REPO -X PATCH -H "Accept: application/vnd.github+json" -f delete_branch_on_merge=true
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
### 4. Start Using the Framework
|
|
104
|
-
|
|
105
|
-
```bash
|
|
106
|
-
# Configure GitHub authentication (one-time setup)
|
|
107
|
-
npx agentic15 auth
|
|
108
|
-
|
|
109
|
-
# Create a project plan
|
|
110
|
-
npx agentic15 plan "Build a todo app with add, remove, and list features"
|
|
111
|
-
|
|
112
|
-
# Start the first task
|
|
113
|
-
npx agentic15 task next
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### 5. Development Workflow
|
|
117
|
-
|
|
118
|
-
**In Claude Code Terminal:**
|
|
119
|
-
1. Ask Claude: "Implement the active task"
|
|
120
|
-
2. Claude writes code in `Agent/` directory
|
|
121
|
-
|
|
122
|
-
**In Your Terminal:**
|
|
123
|
-
```bash
|
|
124
|
-
# When task is complete
|
|
125
|
-
npx agentic15 commit
|
|
126
|
-
# This will: stage changes, commit, push, and create PR
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
**On GitHub:**
|
|
130
|
-
1. Review and merge the PR
|
|
131
|
-
|
|
132
|
-
**Back in Your Terminal:**
|
|
133
|
-
```bash
|
|
134
|
-
# Sync with main branch after PR merge
|
|
135
|
-
npx agentic15 sync
|
|
136
|
-
# This will: switch to main, pull changes, delete feature branch
|
|
137
|
-
|
|
138
|
-
# Continue to next task
|
|
139
|
-
npx agentic15 task next
|
|
140
|
-
```
|
|
20
|
+
| Step | Action | Commands |
|
|
21
|
+
|------|--------|----------|
|
|
22
|
+
| **1. Create Project** | **Bash/Mac/Linux:**<br>`npx @agentic15.com/agentic15-claude-zen my-project`<br>`cd my-project`<br><br>**PowerShell (Windows):**<br>`npx "@agentic15.com/agentic15-claude-zen" my-project`<br>`cd my-project` | Creates new project with framework structure |
|
|
23
|
+
| **2. Initialize Git** | `git init`<br>`git branch -M main`<br>`git add .`<br>`git commit -m "Initial commit"`<br><br>`gh repo create OWNER/REPO --public`<br>`git remote add origin https://github.com/OWNER/REPO.git`<br>`git push -u origin main`<br><br>**Note:** Replace `OWNER/REPO` with your GitHub username/repo | Links project to GitHub (required for PRs) |
|
|
24
|
+
| **3. Configure Auth** | `npx agentic15 auth` | One-time GitHub authentication setup |
|
|
25
|
+
| **4. Create Plan** | **In Terminal:**<br>`npx agentic15 plan "Build a todo app with add, remove, and list features"`<br><br>**In Claude Code (launch from project directory):**<br>Ask: "Create the project plan from the requirements file"<br><br>**Back in Terminal:**<br>`npx agentic15 plan`<br>`git add .`<br>`git commit -m "Add initial project plan"`<br>`git push`<br><br>**Important:** Commit plan to main BEFORE enabling branch protection | Generates and locks project plan |
|
|
26
|
+
| **5. Enable Branch Protection** | **Bash/Mac/Linux:**<br>```cat > /tmp/protection.json << 'EOF'```<br>```{```<br>``` "required_pull_request_reviews": {```<br>``` "required_approving_review_count": 0```<br>``` },```<br>``` "enforce_admins": false,```<br>``` "allow_force_pushes": false,```<br>``` "allow_deletions": false,```<br>``` "required_status_checks": null,```<br>``` "restrictions": null```<br>```}```<br>```EOF```<br><br>```gh api repos/OWNER/REPO/branches/main/protection -X PUT \```<br>``` -H "Accept: application/vnd.github+json" \```<br>``` --input /tmp/protection.json```<br><br>```gh api repos/OWNER/REPO -X PATCH \```<br>``` -H "Accept: application/vnd.github+json" \```<br>``` -f delete_branch_on_merge=true```<br><br>**PowerShell (Windows):**<br>```$body = @"```<br>```{```<br>``` "required_pull_request_reviews": {```<br>``` "required_approving_review_count": 0```<br>``` },```<br>``` "enforce_admins": false,```<br>``` "allow_force_pushes": false,```<br>``` "allow_deletions": false,```<br>``` "required_status_checks": null,```<br>``` "restrictions": null```<br>```}```<br>```"@```<br><br>```echo $body \| gh api repos/OWNER/REPO/branches/main/protection -X PUT -H "Accept: application/vnd.github+json" --input -```<br><br>```gh api repos/OWNER/REPO -X PATCH -H "Accept: application/vnd.github+json" -f delete_branch_on_merge=true``` | Enforces PR-only workflow for all future changes |
|
|
27
|
+
| **6. Start First Task** | `npx agentic15 task next` | Creates feature branch for first task |
|
|
28
|
+
|
|
29
|
+
### Daily Development Workflow
|
|
30
|
+
|
|
31
|
+
| Location | Step | Action |
|
|
32
|
+
|----------|------|--------|
|
|
33
|
+
| **Claude Code** | 1. Implement | Ask: "Implement the active task"<br>Claude writes code in `Agent/` directory |
|
|
34
|
+
| **Your Terminal** | 2. Commit & PR | `npx agentic15 commit`<br>Stages changes, commits, pushes, creates PR |
|
|
35
|
+
| **GitHub** | 3. Review | Review and merge the PR |
|
|
36
|
+
| **Your Terminal** | 4. Sync & Next | `npx agentic15 sync`<br>Syncs with main, deletes feature branch<br><br>`npx agentic15 task next`<br>Starts next task |
|
|
141
37
|
|
|
142
38
|
---
|
|
143
39
|
|
|
@@ -154,7 +50,6 @@ npx agentic15 task next
|
|
|
154
50
|
| `npx agentic15 commit` | Commit, push, and create PR |
|
|
155
51
|
| `npx agentic15 sync` | Sync with main branch after PR merge |
|
|
156
52
|
| `npx agentic15 visual-test <url>` | Capture UI screenshots and console errors |
|
|
157
|
-
| `npx agentic15 upgrade` | Update framework files |
|
|
158
53
|
| `npx agentic15 auth` | Configure GitHub authentication |
|
|
159
54
|
|
|
160
55
|
### Workflow Automation
|
|
@@ -178,11 +73,22 @@ plan → task → code → commit → PR → merge → sync → next task
|
|
|
178
73
|
|
|
179
74
|
```
|
|
180
75
|
my-project/
|
|
181
|
-
├──
|
|
182
|
-
│
|
|
183
|
-
│
|
|
184
|
-
│
|
|
185
|
-
│
|
|
76
|
+
├── node_modules/
|
|
77
|
+
│ └── @agentic15.com/agentic15-claude-zen/
|
|
78
|
+
│ └── framework/ # Framework files (hooks, schemas, templates)
|
|
79
|
+
│ ├── hooks/ # Claude Code hooks
|
|
80
|
+
│ ├── settings.json # Framework settings
|
|
81
|
+
│ ├── PLAN-SCHEMA.json
|
|
82
|
+
│ ├── PROJECT-PLAN-TEMPLATE.json
|
|
83
|
+
│ └── POST-INSTALL.md
|
|
84
|
+
├── .claude/ # User-generated content only
|
|
85
|
+
│ ├── ACTIVE-PLAN # Current active plan
|
|
86
|
+
│ ├── plans/ # Your project plans and tasks
|
|
87
|
+
│ │ └── {planId}/
|
|
88
|
+
│ │ ├── TASK-TRACKER.json
|
|
89
|
+
│ │ └── tasks/
|
|
90
|
+
│ ├── settings.json # References framework in node_modules
|
|
91
|
+
│ └── settings.local.json # Local overrides (optional, gitignored)
|
|
186
92
|
├── Agent/ # Your code workspace
|
|
187
93
|
│ ├── src/ # Source code
|
|
188
94
|
│ └── tests/ # Tests (optional)
|
|
@@ -190,34 +96,70 @@ my-project/
|
|
|
190
96
|
└── package.json # Project dependencies
|
|
191
97
|
```
|
|
192
98
|
|
|
99
|
+
### Framework Upgrades
|
|
100
|
+
|
|
101
|
+
Framework files live in `node_modules` and are automatically updated when you upgrade the package:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# Upgrade to latest version
|
|
105
|
+
npm install @agentic15.com/agentic15-claude-zen@latest
|
|
106
|
+
|
|
107
|
+
# Or to a specific version
|
|
108
|
+
npm install @agentic15.com/agentic15-claude-zen@5.0.0
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
**What gets updated:**
|
|
112
|
+
- ✅ Framework hooks in `node_modules`
|
|
113
|
+
- ✅ Settings schema and templates
|
|
114
|
+
- ✅ CLI commands
|
|
115
|
+
|
|
116
|
+
**What stays unchanged:**
|
|
117
|
+
- ✅ Your code in `Agent/`
|
|
118
|
+
- ✅ Your plans and tasks in `.claude/plans/`
|
|
119
|
+
- ✅ Your local settings in `.claude/settings.local.json`
|
|
120
|
+
|
|
193
121
|
---
|
|
194
122
|
|
|
195
123
|
## GitHub Integration
|
|
196
124
|
|
|
197
|
-
###
|
|
125
|
+
### Authentication
|
|
126
|
+
|
|
127
|
+
The framework uses **GitHub CLI (`gh`)** for authentication - no personal access tokens needed!
|
|
128
|
+
|
|
129
|
+
**Setup:**
|
|
130
|
+
```bash
|
|
131
|
+
npx agentic15 auth
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
This command will:
|
|
135
|
+
1. Check if `gh` CLI is installed
|
|
136
|
+
2. Run `gh auth login` if not already authenticated
|
|
137
|
+
3. Auto-detect your repository owner/repo from git remote
|
|
138
|
+
4. Save configuration to `.claude/settings.local.json`
|
|
198
139
|
|
|
199
|
-
|
|
140
|
+
### Manual Configuration (Optional)
|
|
141
|
+
|
|
142
|
+
If you need to override the auto-detected values, create or edit `.claude/settings.local.json`:
|
|
200
143
|
```json
|
|
201
144
|
{
|
|
202
145
|
"github": {
|
|
203
|
-
"
|
|
146
|
+
"enabled": true,
|
|
147
|
+
"autoCreate": true,
|
|
148
|
+
"autoUpdate": true,
|
|
149
|
+
"autoClose": true,
|
|
204
150
|
"owner": "your-username",
|
|
205
151
|
"repo": "your-repo"
|
|
206
152
|
}
|
|
207
153
|
}
|
|
208
154
|
```
|
|
209
155
|
|
|
210
|
-
|
|
211
|
-
```bash
|
|
212
|
-
export GITHUB_TOKEN="ghp_xxxxxxxxxxxxx"
|
|
213
|
-
export GITHUB_OWNER="your-username"
|
|
214
|
-
export GITHUB_REPO="your-repo"
|
|
215
|
-
```
|
|
156
|
+
**Note:** Authentication is handled by `gh` CLI - no token field needed.
|
|
216
157
|
|
|
217
158
|
### Features
|
|
218
159
|
- **Auto-create issues:** When starting tasks
|
|
219
160
|
- **Auto-update issues:** When creating PRs
|
|
220
161
|
- **Auto-close issues:** When merging to main (optional)
|
|
162
|
+
- **Secure authentication:** Uses `gh` CLI credentials
|
|
221
163
|
|
|
222
164
|
---
|
|
223
165
|
|
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')
|