ce-workflow 0.4.0
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/agent-core/docs/path-resolution.md +105 -0
- package/agent-core/prompts/_base.md +103 -0
- package/agent-core/prompts/cleanup.md +199 -0
- package/agent-core/prompts/design.md +474 -0
- package/agent-core/prompts/develop.md +229 -0
- package/agent-core/prompts/doctor.md +204 -0
- package/agent-core/prompts/documentation.md +71 -0
- package/agent-core/prompts/init.md +176 -0
- package/agent-core/prompts/orchestrator.md +219 -0
- package/agent-core/prompts/sync.md +48 -0
- package/agent-core/templates/docs/.gitkeep +1 -0
- package/agent-core/templates/doctor_output.md +138 -0
- package/agent-core/templates/documentation_output.md +71 -0
- package/agent-core/templates/executor_output.md +64 -0
- package/agent-core/templates/init_output.md +307 -0
- package/agent-core/templates/meta.template.json +54 -0
- package/agent-core/templates/orchestrator_output.md +51 -0
- package/agent-core/templates/planning_output.md +190 -0
- package/agent-core/templates/research_output.md +167 -0
- package/bin/ce-workflow.js +2 -0
- package/dist/index.js +4197 -0
- package/package.json +67 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# CE-Workflow Orchestration Summary
|
|
2
|
+
|
|
3
|
+
**Generated**: {{TIMESTAMP}}
|
|
4
|
+
**Orchestrator**: CE-Workflow Workflow Orchestrator
|
|
5
|
+
**Phases Executed**: {{PHASES_EXECUTED}}
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Workflow Execution Summary
|
|
10
|
+
|
|
11
|
+
### Requested Work
|
|
12
|
+
{{USER_REQUEST}}
|
|
13
|
+
|
|
14
|
+
### Phases Completed
|
|
15
|
+
|
|
16
|
+
{{#each PHASES}}
|
|
17
|
+
#### {{PHASE_NAME}}
|
|
18
|
+
|
|
19
|
+
**Status**: {{STATUS}}
|
|
20
|
+
**Artifact**: `{{ARTIFACT_PATH}}`
|
|
21
|
+
**Duration**: {{DURATION}}
|
|
22
|
+
|
|
23
|
+
**Key Outcomes:**
|
|
24
|
+
{{OUTCOMES}}
|
|
25
|
+
|
|
26
|
+
**Next Steps:**
|
|
27
|
+
{{NEXT_STEPS}}
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
{{/each}}
|
|
32
|
+
|
|
33
|
+
## Overall Status
|
|
34
|
+
|
|
35
|
+
**Completion**: {{COMPLETION_PERCENTAGE}}%
|
|
36
|
+
**Ready for Next Phase**: {{READY_FOR_NEXT}}
|
|
37
|
+
|
|
38
|
+
### Artifacts Generated
|
|
39
|
+
|
|
40
|
+
{{#each ARTIFACTS}}
|
|
41
|
+
- [`{{PATH}}`]({{PATH}}) - {{DESCRIPTION}}
|
|
42
|
+
{{/each}}
|
|
43
|
+
|
|
44
|
+
### Recommendations
|
|
45
|
+
|
|
46
|
+
{{RECOMMENDATIONS}}
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
**Session Complete**: {{SESSION_COMPLETE}}
|
|
51
|
+
**Return Summary**: {{RETURN_SUMMARY}}
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
TEMPLATE: Execution Plan
|
|
3
|
+
|
|
4
|
+
HOW TO USE:
|
|
5
|
+
1. Copy to: {{CE_DATA}}/tasks/{{TASK_SLUG}}/planning/{{TASK_SLUG}}-plan.md
|
|
6
|
+
2. Replace {{variable}} placeholders with actual values
|
|
7
|
+
3. Remove unused table rows and empty sections
|
|
8
|
+
|
|
9
|
+
SYSTEM PATH VARIABLES (Must be replaced by agent using System Resolved Paths):
|
|
10
|
+
- {{CE_DATA}}: Storage path for knowledge/tasks (Use value from system context!)
|
|
11
|
+
- {{WORKSPACE_NAME}}: Project name
|
|
12
|
+
|
|
13
|
+
AGENT-FILLED VARIABLES:
|
|
14
|
+
- {{task_id}}: UUID for the task
|
|
15
|
+
- {{task_slug}}: kebab-case task identifier
|
|
16
|
+
- {{task_title}}: Human-readable task title
|
|
17
|
+
- {{author}}: Git user or agent name (planner)
|
|
18
|
+
- {{date}}: ISO date (YYYY-MM-DD)
|
|
19
|
+
- {{research_artifact}}: Path to research brief
|
|
20
|
+
- {{workspace_name}}: Project name
|
|
21
|
+
|
|
22
|
+
NOTE: This document is the output of an interactive planning session.
|
|
23
|
+
The Planning agent collaborated with the user to break down requirements
|
|
24
|
+
into actionable tasks before this plan was finalized.
|
|
25
|
+
-->
|
|
26
|
+
# Execution Plan – {{task_title}}
|
|
27
|
+
|
|
28
|
+
| Field | Value |
|
|
29
|
+
|-------|-------|
|
|
30
|
+
| Task ID | `{{task_id}}` |
|
|
31
|
+
| Task Slug | `{{task_slug}}` |
|
|
32
|
+
| Planner | `{{author}}` |
|
|
33
|
+
| Date | `{{date}}` |
|
|
34
|
+
| Research Artifact | `{{research_artifact}}` |
|
|
35
|
+
| Workspace | `{{workspace_name}}` |
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 1. Scope Confirmation
|
|
40
|
+
|
|
41
|
+
**From Research Brief**:
|
|
42
|
+
> [Quote the refined understanding from research]
|
|
43
|
+
|
|
44
|
+
**Confirmed Inclusions**:
|
|
45
|
+
- [What will be built]
|
|
46
|
+
|
|
47
|
+
**Confirmed Exclusions**:
|
|
48
|
+
- [What will NOT be built]
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## 2. Objectives & Success Criteria
|
|
53
|
+
|
|
54
|
+
### Primary Objectives
|
|
55
|
+
1. [Objective 1]
|
|
56
|
+
2. [Objective 2]
|
|
57
|
+
|
|
58
|
+
### Success Criteria (from Research)
|
|
59
|
+
| ID | Criteria | How to Verify |
|
|
60
|
+
|----|----------|---------------|
|
|
61
|
+
| SC-1 | [Measurable outcome] | [Verification method] |
|
|
62
|
+
| SC-2 | [Measurable outcome] | [Verification method] |
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## 3. Task Breakdown
|
|
67
|
+
|
|
68
|
+
> **IMPORTANT**: The Executor MUST follow these tasks in order.
|
|
69
|
+
> Each task should be completed and verified before moving to the next.
|
|
70
|
+
|
|
71
|
+
| # | Task | Description | Acceptance Criteria | Effort | Dependencies |
|
|
72
|
+
|---|------|-------------|---------------------|--------|--------------|
|
|
73
|
+
| 1 | [Task Name] | [What to do] | [How to verify done] | S/M/L | None |
|
|
74
|
+
| 2 | [Task Name] | [What to do] | [How to verify done] | S/M/L | Task 1 |
|
|
75
|
+
| 3 | [Task Name] | [What to do] | [How to verify done] | S/M/L | Task 1, 2 |
|
|
76
|
+
| 4 | [Task Name] | [What to do] | [How to verify done] | S/M/L | Task 3 |
|
|
77
|
+
|
|
78
|
+
**Total Estimated Effort**: [Sum or range]
|
|
79
|
+
|
|
80
|
+
### Task Details
|
|
81
|
+
|
|
82
|
+
#### Task 1: [Task Name]
|
|
83
|
+
- **Files to modify**: `path/to/file.ts`
|
|
84
|
+
- **Implementation notes**: [Specific guidance for executor]
|
|
85
|
+
- **Edge cases to handle**: [List any edge cases]
|
|
86
|
+
|
|
87
|
+
#### Task 2: [Task Name]
|
|
88
|
+
- **Files to modify**: `path/to/file.ts`
|
|
89
|
+
- **Implementation notes**: [Specific guidance for executor]
|
|
90
|
+
- **Edge cases to handle**: [List any edge cases]
|
|
91
|
+
|
|
92
|
+
[Continue for each task...]
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## 4. Validation Strategy
|
|
97
|
+
|
|
98
|
+
> The Executor should run these validations after completing the relevant tasks.
|
|
99
|
+
|
|
100
|
+
| Task(s) | Validation Type | Command / Steps |
|
|
101
|
+
|---------|-----------------|-----------------|
|
|
102
|
+
| 1-2 | Unit Tests | `npm test -- --grep 'feature'` |
|
|
103
|
+
| 3 | Integration Test | `npm run test:integration` |
|
|
104
|
+
| All | Type Check | `npm run typecheck` |
|
|
105
|
+
| All | Lint | `npm run lint` |
|
|
106
|
+
| All | Manual Verification | [Specific steps to manually verify] |
|
|
107
|
+
|
|
108
|
+
### Manual Verification Checklist
|
|
109
|
+
- [ ] [Step 1: What to check]
|
|
110
|
+
- [ ] [Step 2: What to check]
|
|
111
|
+
- [ ] [Step 3: What to check]
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## 5. Risks & Mitigations
|
|
116
|
+
|
|
117
|
+
| Risk | Impact | Likelihood | Mitigation | Owner |
|
|
118
|
+
|------|--------|------------|------------|-------|
|
|
119
|
+
| [Risk from research] | High/Med/Low | High/Med/Low | [How to mitigate] | Executor |
|
|
120
|
+
| [Implementation risk] | High/Med/Low | High/Med/Low | [How to mitigate] | Executor |
|
|
121
|
+
|
|
122
|
+
### Blockers Requiring Escalation
|
|
123
|
+
- [Any known blockers that need external support]
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## 6. Technical Guidance
|
|
128
|
+
|
|
129
|
+
### Patterns to Follow
|
|
130
|
+
From project-context.md and knowledge base:
|
|
131
|
+
- [Pattern 1]: [Where to find example in codebase]
|
|
132
|
+
- [Pattern 2]: [Where to find example in codebase]
|
|
133
|
+
|
|
134
|
+
### Coding Conventions
|
|
135
|
+
- [Convention 1 from project context]
|
|
136
|
+
- [Convention 2 from project context]
|
|
137
|
+
|
|
138
|
+
### Dependencies
|
|
139
|
+
- [External dependency 1]: [How to use]
|
|
140
|
+
- [Internal module 1]: [How to import/use]
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## 7. Knowledge Updates
|
|
145
|
+
|
|
146
|
+
Files to create/update in `{{CE_DATA}}/knowledge/` after implementation:
|
|
147
|
+
|
|
148
|
+
| Action | File | Content |
|
|
149
|
+
|--------|------|---------|
|
|
150
|
+
| Create | `{{CE_DATA}}/knowledge/[domain].md` | [What to document] |
|
|
151
|
+
| Update | `{{CE_DATA}}/knowledge/project-context.md` | [What changed] |
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## 8. Handoff Checklist for Executor
|
|
156
|
+
|
|
157
|
+
### Prerequisites Verified
|
|
158
|
+
- [ ] Research brief exists and is complete
|
|
159
|
+
- [ ] Project context is available
|
|
160
|
+
- [ ] All dependencies are installed/available
|
|
161
|
+
|
|
162
|
+
### Executor Must Have
|
|
163
|
+
- [ ] Access to branch: `[branch name if specified]`
|
|
164
|
+
- [ ] [Any required API keys, credentials, or access]
|
|
165
|
+
- [ ] [Any required test data or fixtures]
|
|
166
|
+
|
|
167
|
+
### During Execution
|
|
168
|
+
- [ ] Follow tasks in order (1 → 2 → 3 → ...)
|
|
169
|
+
- [ ] Run validation after each task
|
|
170
|
+
- [ ] Document any deviations from this plan
|
|
171
|
+
- [ ] Update meta.json status as you progress
|
|
172
|
+
|
|
173
|
+
### After Execution
|
|
174
|
+
- [ ] All tasks completed and verified
|
|
175
|
+
- [ ] Execution log saved to `execution/{{task_slug}}-execution.md`
|
|
176
|
+
- [ ] meta.json updated with final status
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## 9. Open Questions (Carried Forward)
|
|
181
|
+
|
|
182
|
+
From research phase (non-blocking):
|
|
183
|
+
- [Question 1] - Can be resolved during execution
|
|
184
|
+
- [Question 2] - Document resolution in execution log
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
> **Next Step**: `/execute TASK_SLUG={{task_slug}}`
|
|
189
|
+
>
|
|
190
|
+
> Keep this plan under 500 lines. Remove unused rows or sections once populated.
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
TEMPLATE: Research Brief
|
|
3
|
+
|
|
4
|
+
HOW TO USE:
|
|
5
|
+
1. Copy to: {{CE_DATA}}/tasks/{{TASK_SLUG}}/research/{{TASK_SLUG}}-research.md
|
|
6
|
+
2. Replace {{variable}} placeholders with actual values
|
|
7
|
+
3. Delete sections that are empty after population
|
|
8
|
+
|
|
9
|
+
SYSTEM PATH VARIABLES (Must be replaced by agent using System Resolved Paths):
|
|
10
|
+
- {{CE_DATA}}: Storage path for knowledge/tasks (Use value from system context!)
|
|
11
|
+
- {{WORKSPACE_NAME}}: Project name
|
|
12
|
+
|
|
13
|
+
AGENT-FILLED VARIABLES:
|
|
14
|
+
- {{task_id}}: UUID for the task
|
|
15
|
+
- {{task_slug}}: kebab-case task identifier
|
|
16
|
+
- {{task_title}}: Human-readable task title
|
|
17
|
+
- {{author}}: Git user or agent name
|
|
18
|
+
- {{date}}: ISO date (YYYY-MM-DD)
|
|
19
|
+
- {{source}}: URL or reference to original request
|
|
20
|
+
- {{workspace_name}}: Project name
|
|
21
|
+
|
|
22
|
+
NOTE: This document is the output of an interactive research session.
|
|
23
|
+
The Research agent engaged in constructive dialogue with the user to
|
|
24
|
+
achieve 100% understanding before this brief was generated.
|
|
25
|
+
-->
|
|
26
|
+
# Research Brief – {{task_title}}
|
|
27
|
+
|
|
28
|
+
| Field | Value |
|
|
29
|
+
|-------|-------|
|
|
30
|
+
| Task ID | `{{task_id}}` |
|
|
31
|
+
| Task Slug | `{{task_slug}}` |
|
|
32
|
+
| Author | `{{author}}` |
|
|
33
|
+
| Date | `{{date}}` |
|
|
34
|
+
| Source Request | `{{source}}` |
|
|
35
|
+
| Workspace | `{{workspace_name}}` |
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 1. Request Summary
|
|
40
|
+
|
|
41
|
+
> **Original Request**: [Quote the user's initial request]
|
|
42
|
+
|
|
43
|
+
**Refined Understanding** (after clarification):
|
|
44
|
+
- [Clear, specific statement of what needs to be built]
|
|
45
|
+
- [Why it needs to be built - problem/opportunity]
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## 2. Clarification Summary
|
|
50
|
+
|
|
51
|
+
The following was clarified through interactive dialogue:
|
|
52
|
+
|
|
53
|
+
| Topic | Question Asked | User Response | Impact on Scope |
|
|
54
|
+
|-------|----------------|---------------|-----------------|
|
|
55
|
+
| Intent | | | |
|
|
56
|
+
| Constraints | | | |
|
|
57
|
+
| Success Criteria | | | |
|
|
58
|
+
| Edge Cases | | | |
|
|
59
|
+
|
|
60
|
+
**Key Decisions Made**:
|
|
61
|
+
- [Decision 1 and rationale]
|
|
62
|
+
- [Decision 2 and rationale]
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## 3. Current Knowledge Snapshot
|
|
67
|
+
|
|
68
|
+
Relevant prior work and context from project knowledge:
|
|
69
|
+
|
|
70
|
+
| Source | Relevance |
|
|
71
|
+
|--------|-----------|
|
|
72
|
+
| `{{CE_DATA}}/knowledge/...` | [How it applies] |
|
|
73
|
+
| [Search result] | [How it applies] |
|
|
74
|
+
|
|
75
|
+
**Patterns to Follow**:
|
|
76
|
+
- [Existing pattern 1 from codebase]
|
|
77
|
+
- [Existing pattern 2 from codebase]
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## 4. Requirements
|
|
82
|
+
|
|
83
|
+
### Functional Requirements
|
|
84
|
+
- [ ] [FR-1]: [Requirement description]
|
|
85
|
+
- [ ] [FR-2]: [Requirement description]
|
|
86
|
+
- [ ] [FR-3]: [Requirement description]
|
|
87
|
+
|
|
88
|
+
### Non-Functional Requirements
|
|
89
|
+
- [ ] [NFR-1]: [Performance/Security/etc. requirement]
|
|
90
|
+
- [ ] [NFR-2]: [Requirement description]
|
|
91
|
+
|
|
92
|
+
### Success Criteria
|
|
93
|
+
How we'll know this is done:
|
|
94
|
+
1. [Measurable outcome 1]
|
|
95
|
+
2. [Measurable outcome 2]
|
|
96
|
+
3. [Measurable outcome 3]
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## 5. Scope Boundaries
|
|
101
|
+
|
|
102
|
+
### In Scope
|
|
103
|
+
- [Explicit inclusion 1]
|
|
104
|
+
- [Explicit inclusion 2]
|
|
105
|
+
|
|
106
|
+
### Out of Scope
|
|
107
|
+
- [Explicit exclusion 1]
|
|
108
|
+
- [Explicit exclusion 2]
|
|
109
|
+
|
|
110
|
+
### Constraints
|
|
111
|
+
- [Hard constraint 1 - e.g., timeline, tech, resources]
|
|
112
|
+
- [Hard constraint 2]
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## 6. Assumptions & Risks
|
|
117
|
+
|
|
118
|
+
### Assumptions
|
|
119
|
+
| ID | Assumption | Confidence | Validation Needed |
|
|
120
|
+
|----|------------|------------|-------------------|
|
|
121
|
+
| A1 | [Assumption] | High/Medium/Low | [How to validate] |
|
|
122
|
+
| A2 | [Assumption] | High/Medium/Low | [How to validate] |
|
|
123
|
+
|
|
124
|
+
### Risks
|
|
125
|
+
| ID | Risk | Impact | Likelihood | Mitigation |
|
|
126
|
+
|----|------|--------|------------|------------|
|
|
127
|
+
| R1 | [Risk description] | High/Medium/Low | High/Medium/Low | [Mitigation] |
|
|
128
|
+
| R2 | [Risk description] | High/Medium/Low | High/Medium/Low | [Mitigation] |
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## 7. Opportunity & Alternative Approaches
|
|
133
|
+
|
|
134
|
+
Approaches considered during research:
|
|
135
|
+
|
|
136
|
+
| Approach | Pros | Cons | Recommendation |
|
|
137
|
+
|----------|------|------|----------------|
|
|
138
|
+
| [Approach A] | | | Chosen / Rejected |
|
|
139
|
+
| [Approach B] | | | Chosen / Rejected |
|
|
140
|
+
|
|
141
|
+
**Rationale for chosen approach**: [Explanation]
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## 8. Hand-off Notes for Planning
|
|
146
|
+
|
|
147
|
+
### Ready for Planning
|
|
148
|
+
- [ ] Core requirements are clear and specific
|
|
149
|
+
- [ ] Success criteria are measurable
|
|
150
|
+
- [ ] Scope boundaries are explicit
|
|
151
|
+
- [ ] No blocking open questions remain
|
|
152
|
+
|
|
153
|
+
### Context for Planning Agent
|
|
154
|
+
- [Important context the planner needs to know]
|
|
155
|
+
- [Technical considerations for task breakdown]
|
|
156
|
+
|
|
157
|
+
### Open Questions (Non-Blocking)
|
|
158
|
+
- [Question that can be resolved during planning or execution]
|
|
159
|
+
|
|
160
|
+
### References Added to meta.json
|
|
161
|
+
- [List of knowledge files referenced]
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
> **Next Step**: `/plan TASK_SLUG={{task_slug}}`
|
|
166
|
+
>
|
|
167
|
+
> Keep this document under 500 lines. Replace placeholders with concise entries and trim empty sections.
|