aidflow 1.0.1 → 1.1.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/README.md
CHANGED
|
@@ -18,7 +18,7 @@ Add to your Claude Code MCP configuration (`~/.claude/settings.json` or project
|
|
|
18
18
|
"aidflow": {
|
|
19
19
|
"command": "aidflow",
|
|
20
20
|
"env": {
|
|
21
|
-
"
|
|
21
|
+
"AIDFLOW_ROOT": "/path/to/your/project"
|
|
22
22
|
}
|
|
23
23
|
}
|
|
24
24
|
}
|
|
@@ -34,14 +34,14 @@ Or run with npx (no install):
|
|
|
34
34
|
"command": "npx",
|
|
35
35
|
"args": ["-y", "aidflow"],
|
|
36
36
|
"env": {
|
|
37
|
-
"
|
|
37
|
+
"AIDFLOW_ROOT": "/path/to/your/project"
|
|
38
38
|
}
|
|
39
39
|
}
|
|
40
40
|
}
|
|
41
41
|
}
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
> `
|
|
44
|
+
> `AIDFLOW_ROOT` defaults to `process.cwd()` if not set.
|
|
45
45
|
|
|
46
46
|
## What It Does
|
|
47
47
|
|
|
@@ -53,7 +53,7 @@ aidflow structures your Claude Code workflow into **sessions** - isolated units
|
|
|
53
53
|
init -> /spec -> session create -> plan create -> work -> /review -> session complete -> /report
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
1. **`init`** - Set up `.
|
|
56
|
+
1. **`init`** - Set up `.aidflow/` directory and configuration
|
|
57
57
|
2. **`/spec`** - Define project engineering foundations (SPEC.md)
|
|
58
58
|
3. **`session create`** - Start a new work session
|
|
59
59
|
4. **`plan create`** - Structured planning with multi-round requirements gathering
|
|
@@ -96,7 +96,7 @@ After `init`, your project gets:
|
|
|
96
96
|
```
|
|
97
97
|
your-project/
|
|
98
98
|
SPEC.md # Project engineering foundations (via /spec)
|
|
99
|
-
.
|
|
99
|
+
.aidflow/
|
|
100
100
|
config.yaml # Configuration
|
|
101
101
|
README.md # Internal documentation
|
|
102
102
|
sessions/ # Active sessions
|
|
@@ -119,22 +119,22 @@ your-project/
|
|
|
119
119
|
|
|
120
120
|
## Configuration
|
|
121
121
|
|
|
122
|
-
`.
|
|
122
|
+
`.aidflow/config.yaml`:
|
|
123
123
|
|
|
124
124
|
```yaml
|
|
125
125
|
version: 1
|
|
126
126
|
|
|
127
127
|
worktree:
|
|
128
128
|
auto: false # Auto-create worktree per session
|
|
129
|
-
path: ".
|
|
129
|
+
path: ".aidflow/worktrees"
|
|
130
130
|
branch_prefix: "" # e.g., "feature/", "fix/"
|
|
131
131
|
|
|
132
132
|
session:
|
|
133
|
-
history_path: ".
|
|
133
|
+
history_path: ".aidflow/history"
|
|
134
134
|
date_format: "YYMMDD" # or "YYYYMMDD"
|
|
135
135
|
|
|
136
136
|
guides:
|
|
137
|
-
path: ".
|
|
137
|
+
path: ".aidflow/guides"
|
|
138
138
|
```
|
|
139
139
|
|
|
140
140
|
## Requirements
|
package/package.json
CHANGED
package/templates/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# aidflow
|
|
2
2
|
|
|
3
3
|
Session-based development workflow manager for Claude Code.
|
|
4
4
|
|
|
5
5
|
## Directory Structure
|
|
6
6
|
|
|
7
7
|
```
|
|
8
|
-
.
|
|
8
|
+
.aidflow/
|
|
9
9
|
config.yaml # Configuration
|
|
10
10
|
sessions/ # Active sessions
|
|
11
11
|
{name}/
|
|
@@ -28,17 +28,17 @@ Session-based development workflow manager for Claude Code.
|
|
|
28
28
|
|-----|------|---------|-------------|
|
|
29
29
|
| `version` | number | `1` | Config version |
|
|
30
30
|
| `worktree.auto` | boolean | `false` | Auto-create worktree on session create |
|
|
31
|
-
| `worktree.path` | string | `".
|
|
31
|
+
| `worktree.path` | string | `".aidflow/worktrees"` | Worktree storage path |
|
|
32
32
|
| `worktree.branch_prefix` | string | `""` | Branch name prefix (e.g., `"feature/"`, `"fix/"`) |
|
|
33
|
-
| `session.history_path` | string | `".
|
|
33
|
+
| `session.history_path` | string | `".aidflow/history"` | Archive destination |
|
|
34
34
|
| `session.date_format` | string | `"YYMMDD"` | Date format for archive names (`YYMMDD` or `YYYYMMDD`) |
|
|
35
|
-
| `guides.path` | string | `".
|
|
35
|
+
| `guides.path` | string | `".aidflow/guides"` | Guide documents path |
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
39
39
|
## meta.json
|
|
40
40
|
|
|
41
|
-
Session metadata. Automatically managed by
|
|
41
|
+
Session metadata. Automatically managed by aidflow.
|
|
42
42
|
|
|
43
43
|
```json
|
|
44
44
|
{
|
|
@@ -47,7 +47,7 @@ Session metadata. Automatically managed by devpilot.
|
|
|
47
47
|
"status": "active",
|
|
48
48
|
"worktree": {
|
|
49
49
|
"enabled": true,
|
|
50
|
-
"path": ".
|
|
50
|
+
"path": ".aidflow/worktrees/fix-auth-bug",
|
|
51
51
|
"branch": "fix-auth-bug"
|
|
52
52
|
}
|
|
53
53
|
}
|
|
@@ -113,7 +113,7 @@ Progress is tracked via checkboxes. `session status` reports completion rate.
|
|
|
113
113
|
|
|
114
114
|
## Guides
|
|
115
115
|
|
|
116
|
-
Markdown files in `.
|
|
116
|
+
Markdown files in `.aidflow/guides/`. Used for project-specific knowledge injection.
|
|
117
117
|
|
|
118
118
|
- First line = title, second line = description
|
|
119
119
|
- Use `guide list` to see available guides
|
package/templates/config.yaml
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
#
|
|
1
|
+
# aidflow configuration
|
|
2
2
|
version: 1
|
|
3
3
|
|
|
4
4
|
worktree:
|
|
5
5
|
# Auto-create worktree for every new session
|
|
6
6
|
auto: false
|
|
7
7
|
# Worktree storage path
|
|
8
|
-
path: ".
|
|
8
|
+
path: ".aidflow/worktrees"
|
|
9
9
|
# Branch name prefix for worktrees (e.g., "feature/", "fix/", or empty)
|
|
10
10
|
branch_prefix: ""
|
|
11
11
|
|
|
12
12
|
session:
|
|
13
13
|
# Archived session storage path
|
|
14
|
-
history_path: ".
|
|
14
|
+
history_path: ".aidflow/history"
|
|
15
15
|
# Date format for archive names (YYMMDD or YYYYMMDD)
|
|
16
16
|
date_format: "YYMMDD"
|
|
17
17
|
|
|
18
18
|
guides:
|
|
19
19
|
# Guide documents path
|
|
20
|
-
path: ".
|
|
20
|
+
path: ".aidflow/guides"
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Getting Started
|
|
2
|
-
Quick guide to using
|
|
2
|
+
Quick guide to using aidflow in this project.
|
|
3
3
|
|
|
4
4
|
## Session Workflow
|
|
5
5
|
|
|
@@ -17,5 +17,5 @@ For isolated parallel work, create sessions with worktrees:
|
|
|
17
17
|
|
|
18
18
|
## Guides
|
|
19
19
|
|
|
20
|
-
Add project-specific guides to `.
|
|
20
|
+
Add project-specific guides to `.aidflow/guides/` as markdown files.
|
|
21
21
|
Use `guide list` to see available guides.
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: finish
|
|
3
|
+
description: Complete session - review, archive, report, and commit in one step.
|
|
4
|
+
allowed-tools: Read, Write, Edit, Glob, Grep, Bash, WebSearch
|
|
5
|
+
user-invokable: true
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Complete the current session by running review, archive, report, and commit sequentially.
|
|
9
|
+
Stop immediately at any step if a blocking issue is found.
|
|
10
|
+
|
|
11
|
+
## Step 1: Review
|
|
12
|
+
|
|
13
|
+
1. **Identify the active session**
|
|
14
|
+
- Use `session status` to find the current session and its changed files
|
|
15
|
+
- Read plan.md to understand what was intended
|
|
16
|
+
|
|
17
|
+
2. **Code Review - Changed Files**
|
|
18
|
+
Read EVERY changed file and check:
|
|
19
|
+
- Does the implementation match plan.md requirements?
|
|
20
|
+
- Are there any incomplete TODOs or FIXMEs?
|
|
21
|
+
- Error handling: are edge cases covered?
|
|
22
|
+
- If SPEC.md exists, do changes follow its conventions?
|
|
23
|
+
- Are there any hardcoded values that should be configurable?
|
|
24
|
+
- Security: no exposed secrets, no injection vulnerabilities?
|
|
25
|
+
|
|
26
|
+
3. **Consistency Check**
|
|
27
|
+
- Naming conventions consistent across new/modified code?
|
|
28
|
+
- Import patterns match existing codebase style?
|
|
29
|
+
- No duplicate logic that should be extracted?
|
|
30
|
+
- No dead code or unused imports left behind?
|
|
31
|
+
|
|
32
|
+
4. **Test Coverage**
|
|
33
|
+
- Run existing tests: `npm test` (or project-specific command from SPEC.md)
|
|
34
|
+
- If tests fail, STOP here and report failures to the user
|
|
35
|
+
|
|
36
|
+
5. **Plan Completion Audit**
|
|
37
|
+
- Check each Implementation Item and Acceptance Criteria in plan.md
|
|
38
|
+
- Ensure all `- [ ]` items are checked `- [x]` if completed
|
|
39
|
+
- Flag any genuinely unchecked items
|
|
40
|
+
|
|
41
|
+
6. **Review Gate**
|
|
42
|
+
- If blocking issues found: present them with AskUserQuestion, offer "Fix now" / "Proceed anyway" / "Cancel"
|
|
43
|
+
- If "Fix now": fix issues, then restart from Step 1
|
|
44
|
+
- If "Cancel": stop entirely
|
|
45
|
+
- If no issues or "Proceed anyway": continue to Step 2
|
|
46
|
+
|
|
47
|
+
## Step 2: Archive Session
|
|
48
|
+
|
|
49
|
+
Run `session complete` to archive the session.
|
|
50
|
+
- If it fails due to incomplete plan items, use `force: true`
|
|
51
|
+
|
|
52
|
+
## Step 3: Generate Report
|
|
53
|
+
|
|
54
|
+
1. Find the latest directory in `.aidflow/history/` (sorted by name, newest first)
|
|
55
|
+
2. Read `meta.json` from that directory to get session metadata
|
|
56
|
+
3. Read `plan.md` from that directory (if exists)
|
|
57
|
+
4. Gather git commits for the session period:
|
|
58
|
+
- Use `created_at` and `completed_at` from meta.json as the time range
|
|
59
|
+
- Run: `git log --oneline --after="{created_at}" --before="{completed_at}"`
|
|
60
|
+
5. Read the changed files listed in meta.json and briefly review each
|
|
61
|
+
6. Write `report.md` in the history directory with this format:
|
|
62
|
+
|
|
63
|
+
```markdown
|
|
64
|
+
# {Session Name} - Report
|
|
65
|
+
|
|
66
|
+
## Summary
|
|
67
|
+
{1-2 line summary of what was accomplished}
|
|
68
|
+
|
|
69
|
+
## Plan Completion
|
|
70
|
+
{Plan items and their completion status, if plan existed}
|
|
71
|
+
|
|
72
|
+
## Changed Files
|
|
73
|
+
| File | Change Type | Description |
|
|
74
|
+
|------|-------------|-------------|
|
|
75
|
+
| path/to/file | modified/new/deleted | Brief description |
|
|
76
|
+
|
|
77
|
+
## Key Decisions
|
|
78
|
+
{Important technical decisions made during the work}
|
|
79
|
+
|
|
80
|
+
## Issues & Observations
|
|
81
|
+
{Any issues found, edge cases, or observations for future reference}
|
|
82
|
+
|
|
83
|
+
## Duration
|
|
84
|
+
- Started: {created_at}
|
|
85
|
+
- Completed: {completed_at}
|
|
86
|
+
- Commits: {number}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Step 4: Git Commit
|
|
90
|
+
|
|
91
|
+
1. Run `git status` and `git diff` to see all changes
|
|
92
|
+
2. Stage relevant files (avoid .env, credentials, etc.)
|
|
93
|
+
3. Draft a commit message following project conventions:
|
|
94
|
+
- Message in Korean
|
|
95
|
+
- NO Co-Authored-By or AI traces
|
|
96
|
+
- Format: short title + blank line + bullet point details (if needed)
|
|
97
|
+
4. Present the commit message to the user with AskUserQuestion for approval
|
|
98
|
+
5. Create the commit after approval
|
|
99
|
+
|
|
100
|
+
## Step 5: SPEC.md Check
|
|
101
|
+
|
|
102
|
+
Ask the user with AskUserQuestion:
|
|
103
|
+
"This session introduced changes. Should SPEC.md be updated to reflect new patterns or conventions?"
|
|
104
|
+
- If yes: run `/spec` to update
|
|
105
|
+
- If no: done
|
|
106
|
+
|
|
107
|
+
## Notes
|
|
108
|
+
- Be thorough but practical in review - flag real issues, not style nitpicks
|
|
109
|
+
- If the project has a linter/formatter, run it during review
|
|
110
|
+
- Focus on correctness and completeness over perfection
|
|
111
|
+
- Keep report descriptions concise but informative
|
|
@@ -10,7 +10,7 @@ Generate a completion report for the most recently archived session.
|
|
|
10
10
|
|
|
11
11
|
## Steps
|
|
12
12
|
|
|
13
|
-
1. Find the latest directory in `.
|
|
13
|
+
1. Find the latest directory in `.aidflow/history/` (sorted by name, newest first)
|
|
14
14
|
2. Read `meta.json` from that directory to get session metadata
|
|
15
15
|
3. Read `plan.md` from that directory (if exists)
|
|
16
16
|
4. Gather git commits for the session period:
|