devflow-kit 0.3.3 → 0.5.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.
@@ -1,5 +1,5 @@
1
1
  ---
2
- allowed-tools: Bash, Read, Grep, Glob, Write, TodoWrite, Task
2
+ allowed-tools: Task, Write, TodoWrite
3
3
  description: Create a development log entry capturing current project state and context
4
4
  ---
5
5
 
@@ -7,186 +7,208 @@ description: Create a development log entry capturing current project state and
7
7
 
8
8
  Create a comprehensive development log entry that captures the current state of the project, recent work, decisions made, and what's left to do. This serves as a time capsule for any developer (including yourself) returning to this project later.
9
9
 
10
- ### Step 1: Capture Agent's Internal Todo List
10
+ **Architecture**: Session context (inline) + Project state (agent) → Synthesized documentation
11
11
 
12
- **CRITICAL FIRST STEP**: Before doing anything else, capture the agent's current internal todo list state.
12
+ ---
13
13
 
14
- Use TodoWrite to dump the current todo list, then immediately document it:
14
+ ## Step 1: Capture Session Context
15
15
 
16
- ```bash
17
- # This will be the current todo list that needs to be preserved
18
- # The agent should use TodoWrite to get their current state
16
+ **CRITICAL**: Capture session-local data that only the main session has access to.
17
+
18
+ ### 1.1 Get Current Todo List State
19
+
20
+ Use TodoWrite to get the current todo list state. This MUST be preserved for session continuity:
21
+
22
+ ```json
23
+ {Current todo list with exact status of all tasks}
19
24
  ```
20
25
 
21
- **MANDATORY**: Document ALL current todos with their exact status:
22
- - content (exact task description)
23
- - status (pending/in_progress/completed)
24
- - activeForm (present tense description)
26
+ **Document**:
27
+ - All current todos with content, status, activeForm
28
+ - Summary counts (pending, in_progress, completed)
29
+ - Current active task
30
+ - Next priority
25
31
 
26
- This state MUST be preserved so future sessions can recreate the todo list exactly.
32
+ ### 1.2 Analyze Current Conversation
27
33
 
28
- ### Step 2: Gather Context
34
+ Review the current conversation to extract:
29
35
 
30
- Determine the current date/time and project information:
36
+ **What We Were Working On:**
37
+ - Main feature/task being developed
38
+ - Specific goals of this session
31
39
 
32
- ```bash
33
- # Get current date in DD-MM-YYYY format
34
- DATE=$(date +"%d-%m-%Y")
35
- TIME=$(date +"%H%M")
36
- TIMESTAMP="${DATE}_${TIME}"
40
+ **Problems Solved:**
41
+ - Issues encountered and how they were resolved
42
+ - Blockers that were removed
43
+ - Bugs fixed
37
44
 
38
- # Get project name from current directory
39
- PROJECT_NAME=$(basename $(pwd))
45
+ **Decisions Made:**
46
+ - Technical decisions with rationale
47
+ - Alternatives considered and why rejected
48
+ - Architecture or design choices
49
+
50
+ **Session Metadata:**
51
+ - Estimated complexity (Simple/Medium/Complex)
52
+ - Original user request
53
+ - Approach taken
54
+
55
+ ### 1.3 Extract Next Steps
40
56
 
41
- # Create docs directory if it doesn't exist
42
- mkdir -p .docs/status
57
+ From the conversation, identify:
58
+ - Immediate tasks for next session
59
+ - Short-term goals (this week)
60
+ - Long-term goals (this month)
61
+
62
+ ---
63
+
64
+ ## Step 2: Launch Project State Agent
65
+
66
+ Launch the `project-state` agent to gather comprehensive codebase analysis:
67
+
68
+ ```
69
+ Task(
70
+ subagent_type="project-state",
71
+ description="Analyze project state",
72
+ prompt="Analyze the current project state including:
73
+ - Git history and recent commits
74
+ - Recently modified files
75
+ - Pending work (TODOs, FIXMEs, HACKs)
76
+ - Documentation structure
77
+ - Technology stack
78
+ - Dependencies
79
+ - Code statistics
80
+
81
+ Return structured data for status documentation."
82
+ )
43
83
  ```
44
84
 
45
- ### Step 3: Analyze Current Conversation
85
+ The agent will analyze and return:
86
+ - Git history (commits, branch, status)
87
+ - Recent file changes
88
+ - TODO/FIXME/HACK markers
89
+ - Documentation structure
90
+ - Tech stack detection
91
+ - Dependencies overview
92
+ - Code statistics
46
93
 
47
- Review the current conversation context to understand:
48
- - What was being worked on
49
- - What problems were solved
50
- - What decisions were made
51
- - What's still pending
94
+ ---
52
95
 
53
- ### Step 4: Gather Project State
96
+ ## Step 3: Synthesize Comprehensive Status Document
54
97
 
55
- Analyze the current project state:
98
+ After the agent completes, synthesize session context + agent data.
99
+
100
+ ### 3.1 Prepare Data
101
+
102
+ Extract from agent output:
103
+ - Git log → Recent Changes section
104
+ - File changes → Files Modified section
105
+ - TODOs → Known Issues section
106
+ - Documentation → Related Documents section
107
+ - Tech stack → Technology Stack section
108
+
109
+ Combine with session context:
110
+ - Current Focus → From conversation analysis
111
+ - Problems Solved → From session
112
+ - Decisions Made → From session
113
+ - Todo List State → From TodoWrite
114
+ - Next Steps → From conversation
115
+
116
+ ### 3.2 Generate Timestamp and Paths
56
117
 
57
118
  ```bash
58
- # Recent git activity
59
- git log --oneline -10 2>/dev/null || echo "No git history"
60
-
61
- # Current branch and status
62
- git branch --show-current 2>/dev/null
63
- git status --short 2>/dev/null
64
-
65
- # Recent file changes
66
- find . -type f -mtime -1 -not -path "*/node_modules/*" -not -path "*/.git/*" -not -path "*/venv/*" -not -path "*/target/*" -not -path "*/build/*" 2>/dev/null | head -20
67
-
68
- # Check for TODO/FIXME comments across common source file extensions
69
- grep -r "TODO\|FIXME\|HACK\|XXX" \
70
- --include="*.js" --include="*.ts" --include="*.jsx" --include="*.tsx" \
71
- --include="*.py" --include="*.go" --include="*.rs" --include="*.java" \
72
- --include="*.c" --include="*.cpp" --include="*.h" --include="*.hpp" \
73
- --include="*.rb" --include="*.php" --include="*.swift" --include="*.kt" \
74
- -l 2>/dev/null | head -10
119
+ # Get timestamp
120
+ DATE=$(date +"%d-%m-%Y")
121
+ TIME=$(date +"%H%M")
122
+ TIMESTAMP="${DATE}_${TIME}"
123
+ PROJECT_NAME=$(basename $(pwd))
75
124
  ```
76
125
 
77
- ### Step 5: Check Documentation
126
+ Paths:
127
+ - Full: `.docs/status/${TIMESTAMP}.md`
128
+ - Compact: `.docs/status/compact/${TIMESTAMP}.md`
129
+ - Index: `.docs/status/INDEX.md`
78
130
 
79
- Look for existing project documentation to understand:
80
- - Architecture decisions (ARCHITECTURE.md, ADR/)
81
- - README status
82
- - API documentation
83
- - Any existing notes
131
+ ---
84
132
 
85
- ### Step 6: Generate Comprehensive Status Document
133
+ ## Step 4: Write Comprehensive Status Document
86
134
 
87
- Create `.docs/status/{timestamp}.md` with the following structure:
135
+ Create `.docs/status/${TIMESTAMP}.md` with:
88
136
 
89
137
  ```markdown
90
- # Project Status - {PROJECT_NAME}
91
- **Date**: {DATE}
92
- **Time**: {TIME}
138
+ # Project Status - ${PROJECT_NAME}
139
+ **Date**: ${DATE}
140
+ **Time**: ${TIME}
93
141
  **Author**: Claude (AI Assistant)
94
- **Session Context**: {Brief description of what was being worked on}
142
+ **Session Context**: {Brief description from conversation}
95
143
 
96
144
  ---
97
145
 
98
146
  ## 🎯 Current Focus
99
147
 
100
148
  ### What We Were Working On
101
- {Detailed description of the current task/feature being developed}
149
+ {From conversation analysis - detailed description}
102
150
 
103
151
  ### Problems Solved Today
104
- 1. {Problem 1 and solution}
105
- 2. {Problem 2 and solution}
106
- 3. {Problem 3 and solution}
152
+ {From conversation - list with solutions}
107
153
 
108
154
  ### Decisions Made
109
- - **Decision**: {What was decided}
110
- **Rationale**: {Why this approach}
111
- **Alternatives Considered**: {Other options that were rejected}
155
+ {From conversation - decisions with rationale and alternatives}
112
156
 
113
157
  ---
114
158
 
115
159
  ## 📊 Project State
116
160
 
117
161
  ### Recent Changes
118
- ```
119
- {Git log showing recent commits}
120
- ```
162
+ {From agent - git log}
121
163
 
122
164
  ### Files Modified Recently
123
- - `path/to/file1` - {What was changed and why}
124
- - `path/to/file2` - {What was changed and why}
165
+ {From agent - recent file changes with analysis}
125
166
 
126
167
  ### Current Branch
127
- - Branch: `{branch_name}`
128
- - Status: {Clean/Dirty with uncommitted changes}
168
+ {From agent - branch name and status}
129
169
 
130
170
  ---
131
171
 
132
172
  ## 🏗️ Architecture & Design
133
173
 
134
174
  ### Key Architectural Decisions
135
- 1. {Pattern/Decision 1}
136
- - Why: {Rationale}
137
- - Impact: {How it affects the codebase}
138
-
139
- 2. {Pattern/Decision 2}
140
- - Why: {Rationale}
141
- - Impact: {How it affects the codebase}
175
+ {From conversation - patterns and decisions from session}
142
176
 
143
177
  ### Technology Stack
144
- - **Language**: {Primary programming language}
145
- - **Framework**: {Main framework or runtime}
146
- - **Data Storage**: {Database or storage system}
147
- - **Key Dependencies**: {Critical libraries or packages}
178
+ {From agent - detected tech stack}
148
179
 
149
180
  ### Design Patterns in Use
150
- - {Pattern 1}: {Where and why}
151
- - {Pattern 2}: {Where and why}
181
+ {From conversation + existing docs}
152
182
 
153
183
  ---
154
184
 
155
185
  ## ⚠️ Known Issues & Technical Debt
156
186
 
157
187
  ### Critical Issues
158
- 1. {Issue description}
159
- - Location: `file/path`
160
- - Impact: {High/Medium/Low}
161
- - Suggested Fix: {Approach}
188
+ {From conversation - issues discussed}
162
189
 
163
190
  ### Technical Debt
164
- 1. {Debt item}
165
- - Why it exists: {Historical reason}
166
- - Cost of fixing: {Estimate}
167
- - Priority: {High/Medium/Low}
191
+ {From conversation - debt mentioned}
168
192
 
169
193
  ### TODOs in Codebase
170
- ```
171
- {List of files with TODO/FIXME comments}
172
- ```
194
+ {From agent - TODO/FIXME/HACK analysis}
173
195
 
174
196
  ---
175
197
 
176
198
  ## 📋 Agent Todo List State
177
199
 
178
- **CRITICAL**: This section preserves the agent's internal todo list state for session continuity.
200
+ **CRITICAL**: Preserves agent's internal todo list for session continuity.
179
201
 
180
202
  ### Current Todo List (for recreation)
181
203
  ```json
182
- {Exact TodoWrite JSON with all current todos}
204
+ {Exact TodoWrite JSON from Step 1}
183
205
  ```
184
206
 
185
207
  ### Todo Summary
186
208
  - **Total tasks**: {count}
187
- - **Pending**: {count of pending tasks}
188
- - **In Progress**: {count of in_progress tasks}
189
- - **Completed**: {count of completed tasks}
209
+ - **Pending**: {count}
210
+ - **In Progress**: {count}
211
+ - **Completed**: {count}
190
212
 
191
213
  ### Key Active Tasks
192
214
  - 🔄 **In Progress**: {current active task}
@@ -198,69 +220,58 @@ Create `.docs/status/{timestamp}.md` with the following structure:
198
220
 
199
221
  ### Immediate (Next Session)
200
222
  - [ ] **FIRST**: Recreate agent todo list using TodoWrite with preserved state above
201
- - [ ] {Task 1 from conversation}
202
- - [ ] {Task 2 from conversation}
203
- - [ ] {Task 3 from conversation}
223
+ {From conversation - immediate tasks}
204
224
 
205
225
  ### Short Term (This Week)
206
- - [ ] {Goal 1}
207
- - [ ] {Goal 2}
226
+ {From conversation - short term goals}
208
227
 
209
228
  ### Long Term (This Month)
210
- - [ ] {Major milestone 1}
211
- - [ ] {Major milestone 2}
229
+ {From conversation - long term goals}
212
230
 
213
231
  ---
214
232
 
215
233
  ## 💡 Context for Future Developer
216
234
 
217
235
  ### Things to Know
218
- 1. **Gotcha #1**: {Something non-obvious}
219
- 2. **Gotcha #2**: {Another tricky thing}
220
- 3. **Convention**: {Project-specific convention}
236
+ {From conversation - gotchas, conventions, non-obvious things}
221
237
 
222
238
  ### Where to Start
223
- If you're picking this up later, here's where to begin:
224
- 1. Check {specific file/area}
225
- 2. Review {documentation}
226
- 3. Run {command} to verify setup
239
+ {Guidance for picking up this work}
227
240
 
228
241
  ### Key Files to Understand
229
- - `path/to/important/file1` - {Why it's important}
230
- - `path/to/important/file2` - {Why it's important}
242
+ {From conversation + agent file analysis}
231
243
 
232
244
  ### Testing Strategy
233
- - How to run tests: `{command}`
234
- - Test coverage: {status}
235
- - Critical test files: {list}
245
+ {From agent - test detection and conversation}
236
246
 
237
247
  ---
238
248
 
239
249
  ## 🔗 Related Documents
240
250
 
241
251
  ### Project Documentation
242
- - README.md - {Status: Updated/Outdated/Missing}
243
- - CONTRIBUTING.md - {Status}
244
- - ARCHITECTURE.md - {Status}
252
+ {From agent - README, CONTRIBUTING, ARCHITECTURE status}
253
+
254
+ ### DevFlow Documentation
255
+ {From agent - .docs/ structure}
245
256
 
246
257
  ### Previous Status Notes
247
- {Link to previous status documents if they exist}
258
+ {Link to previous status documents}
248
259
 
249
260
  ---
250
261
 
251
262
  ## 📝 Raw Session Notes
252
263
 
253
264
  ### What the User Asked For
254
- {Original user request}
265
+ {From conversation - original request}
255
266
 
256
267
  ### Approach Taken
257
- {Step-by-step what was done}
268
+ {From conversation - what was done}
258
269
 
259
270
  ### Challenges Encountered
260
- {Any difficulties and how they were resolved}
271
+ {From conversation - difficulties and resolutions}
261
272
 
262
273
  ### Time Spent
263
- - Estimated session duration: {from timestamp data if available}
274
+ - Estimated session duration: {infer from context}
264
275
  - Complexity level: {Simple/Medium/Complex}
265
276
 
266
277
  ---
@@ -268,19 +279,17 @@ If you're picking this up later, here's where to begin:
268
279
  ## 🤖 AI Assistant Metadata
269
280
 
270
281
  ### Model Used
271
- - Model: {Claude model version}
272
- - Capabilities: {What tools were available}
273
- - Limitations encountered: {Any AI limitations that affected work}
282
+ - Model: Claude Sonnet 4.5
283
+ - Session type: {Regular/Continued/Catch-up}
274
284
 
275
285
  ### Commands/Tools Used
276
- - {Tool 1}: {How it was used}
277
- - {Tool 2}: {How it was used}
286
+ {From conversation - which DevFlow commands were used}
278
287
 
279
288
  ---
280
289
 
281
290
  ## 📌 Final Thoughts
282
291
 
283
- {A brief paragraph of final thoughts, advice, or warnings for whoever picks this up next. Written in first person as if leaving a note to your future self or a colleague.}
292
+ {A brief paragraph from the perspective of leaving a note to future self or colleague. Written in first person with context, advice, and warnings.}
284
293
 
285
294
  **Remember**: This is a snapshot in time. The project will have evolved since this was written. Use this as a starting point for understanding, not as gospel truth.
286
295
 
@@ -289,82 +298,112 @@ If you're picking this up later, here's where to begin:
289
298
  *To generate a new status report, run `/devlog` in Claude Code*
290
299
  ```
291
300
 
292
- ### Step 7: Create Compact Version
301
+ ---
302
+
303
+ ## Step 5: Write Compact Summary
293
304
 
294
- Create a compact summary at `.docs/status/compact/{timestamp}.md`:
305
+ Create `.docs/status/compact/${TIMESTAMP}.md`:
295
306
 
296
307
  ```markdown
297
- # Compact Status - {DATE}
308
+ # Compact Status - ${DATE}
298
309
 
299
- **Focus**: {One-line summary of what was worked on}
310
+ **Focus**: {One-line summary from conversation}
300
311
 
301
312
  **Key Accomplishments**:
302
- - {Accomplishment 1}
303
- - {Accomplishment 2}
304
- - {Accomplishment 3}
313
+ {Top 3 accomplishments from session}
305
314
 
306
315
  **Critical Decisions**:
307
- - {Decision 1}: {Brief rationale}
308
- - {Decision 2}: {Brief rationale}
316
+ {Top 2-3 decisions with brief rationale}
309
317
 
310
318
  **Next Priority Actions**:
311
- - [ ] {Top priority task}
312
- - [ ] {Second priority task}
313
- - [ ] {Third priority task}
319
+ {Top 3 immediate todos}
314
320
 
315
321
  **Critical Issues**:
316
- - {Blocker 1}: {One-line description}
317
- - {Blocker 2}: {One-line description}
322
+ {Top 2 blockers or issues}
318
323
 
319
324
  **Key Files Modified**:
320
- - `{file1}` - {Brief change description}
321
- - `{file2}` - {Brief change description}
322
- - `{file3}` - {Brief change description}
325
+ {Top 5 files from agent analysis}
323
326
 
324
327
  **Context Notes**:
325
328
  {2-3 sentences of essential context for future sessions}
326
329
 
327
330
  ---
328
- *Quick summary of [full status](./../{timestamp}.md)*
331
+ *Quick summary of [full status](./../${TIMESTAMP}.md)*
329
332
  ```
330
333
 
331
- ### Step 8: Create Summary Index
334
+ ---
335
+
336
+ ## Step 6: Update Status Index
332
337
 
333
- Also update or create `.docs/status/INDEX.md` to list all status documents:
338
+ Update or create `.docs/status/INDEX.md`:
334
339
 
335
340
  ```markdown
336
341
  # Status Document Index
337
342
 
338
343
  ## Quick Reference
339
- - [Latest Catch-Up Summary](../CATCH_UP.md) - For getting back up to speed
344
+ - Latest session: ${DATE} ${TIME}
340
345
 
341
346
  ## Recent Status Reports
342
347
 
343
348
  | Date | Time | Focus | Full | Compact |
344
349
  |------|------|-------|------|---------|
345
- | {DATE} | {TIME} | {Brief description} | [Full](./{timestamp}.md) | [Quick](./compact/{timestamp}.md) |
346
- {Previous entries...}
350
+ | ${DATE} | ${TIME} | {Brief from conversation} | [Full](./${TIMESTAMP}.md) | [Quick](./compact/${TIMESTAMP}.md) |
351
+ {Keep previous 10 entries}
347
352
 
348
353
  ## Usage
349
- - **Starting a session?** → Use `/catch-up` command or check latest compact status
354
+ - **Starting a session?** → Use `/catch-up` command
350
355
  - **Ending a session?** → Use `/devlog` to document progress
351
356
  - **Need full context?** → Read the full status documents
352
357
  - **Quick reference?** → Use compact versions
353
358
  ```
354
359
 
355
- ### Step 9: Confirm Creation
360
+ ---
361
+
362
+ ## Step 7: Confirm Creation
363
+
364
+ Provide confirmation to user:
365
+
366
+ ```markdown
367
+ 📝 **Development Log Created**
368
+
369
+ **Full Status**: `.docs/status/${TIMESTAMP}.md`
370
+ **Compact**: `.docs/status/compact/${TIMESTAMP}.md`
371
+ **Index**: `.docs/status/INDEX.md`
372
+
373
+ ### Captured
374
+ - ✅ Session conversation and decisions
375
+ - ✅ Current todo list state (for continuity)
376
+ - ✅ Project state analysis from agent
377
+ - ✅ {X} commits, {Y} files modified
378
+ - ✅ {Z} TODOs/FIXMEs tracked
379
+ - ✅ Next steps documented
380
+
381
+ ### Next Session
382
+ Run `/catch-up` to restore context and recreate todo list.
383
+
384
+ {Brief 2-3 sentence summary of what was accomplished this session}
385
+ ```
386
+
387
+ ---
388
+
389
+ ## Important Notes
356
390
 
357
- After creating the document, provide confirmation:
358
- - Full path to the created document
359
- - Brief summary of what was captured
360
- - Suggestion to review and edit if needed
391
+ **What Stays Inline:**
392
+ - Todo list capture (session state)
393
+ - Conversation analysis (session context)
394
+ - Document synthesis and writing
361
395
 
362
- ### Important Considerations
396
+ **What Agent Handles:**
397
+ - Git history analysis
398
+ - File change detection
399
+ - TODO/FIXME scanning
400
+ - Documentation structure
401
+ - Tech stack detection
363
402
 
364
- 1. **Be Honest**: Include both successes and failures
365
- 2. **Be Specific**: Use actual file paths and function names
366
- 3. **Be Helpful**: Write as if explaining to someone unfamiliar with recent work
367
- 4. **Be Concise**: Balance detail with readability
368
- 5. **Include Context**: Explain the "why" behind decisions
403
+ **Benefits:**
404
+ - Main session stays focused on conversation
405
+ - Heavy codebase analysis offloaded to agent
406
+ - Clean separation: session context vs project state
407
+ - Agent can evolve independently
369
408
 
370
- The goal is to create a time capsule that will be genuinely useful when someone (maybe you!) returns to this project after weeks or months away.
409
+ The goal is to create a time capsule that will be genuinely useful when someone (maybe you!) returns to this project after weeks or months away.