@relipa/ai-flow-kit 0.0.4-beta.3 → 0.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/custom/templates/laravel.md +15 -15
- package/custom/templates/nestjs.md +72 -72
- package/custom/templates/nextjs.md +14 -14
- package/custom/templates/nodejs-express.md +73 -73
- package/custom/templates/python-django.md +71 -71
- package/custom/templates/python-fastapi.md +54 -54
- package/custom/templates/reactjs.md +492 -492
- package/custom/templates/shared/gate-workflow.md +75 -75
- package/custom/templates/spring-boot.md +523 -523
- package/custom/templates/tools/claude.md +13 -0
- package/custom/templates/tools/copilot.md +12 -8
- package/custom/templates/tools/cursor.md +12 -8
- package/custom/templates/tools/gemini.md +12 -8
- package/custom/templates/tools/generic.md +17 -12
- package/custom/templates/vue-nuxt.md +14 -14
- package/{CHANGELOG.md → docs/CHANGELOG.md} +13 -5
- package/{IMPLEMENTATION_SUMMARY.md → docs/IMPLEMENTATION_SUMMARY.md} +21 -39
- package/{QUICK_START.md → docs/QUICK_START.md} +8 -8
- package/{README.md → docs/README.md} +11 -6
- package/docs/ai-integration.md +53 -53
- package/docs/architecture.md +4 -5
- package/docs/developer-overview.md +126 -126
- package/package.json +2 -8
- package/scripts/hooks/session-start.js +1 -1
- package/scripts/init.js +501 -460
- package/scripts/use.js +594 -594
- package/CONTRIBUTING.md +0 -388
- /package/{AIFLOW.md → docs/AIFLOW.md} +0 -0
|
@@ -1,126 +1,126 @@
|
|
|
1
|
-
# AI Flow Kit — Developer Rollout Guide
|
|
2
|
-
|
|
3
|
-
Welcome to the **AI Flow Kit**! This guide is designed to get you up and running with our standardized AI development workflow.
|
|
4
|
-
|
|
5
|
-
## 1. What is AI Flow Kit?
|
|
6
|
-
|
|
7
|
-
It's a "Zero-Config" framework for AI-assisted development. It automatically:
|
|
8
|
-
- Pulls ticket context (requirements, comments) from Backlog/Jira.
|
|
9
|
-
- Orchestrates a **5-Gate Workflow** (Analyze → Plan → Code → Review → PR).
|
|
10
|
-
- Enforces team coding standards and architecture rules.
|
|
11
|
-
- Synchronizes state across different AI tools (Claude, Cursor, Gemini).
|
|
12
|
-
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
## 2. Prerequisites
|
|
16
|
-
|
|
17
|
-
Before starting, ensure you have:
|
|
18
|
-
1. **Node.js** (v18 or higher).
|
|
19
|
-
2. **AI Tool(s)**:
|
|
20
|
-
- **Claude Code CLI** (Recommended for analysis and heavy tasks).
|
|
21
|
-
- **Cursor AI** (Recommended for coding and UI work).
|
|
22
|
-
- **Gemini CLI** or **GitHub Copilot** (Alternative options).
|
|
23
|
-
|
|
24
|
-
---
|
|
25
|
-
|
|
26
|
-
## 3. Installation
|
|
27
|
-
|
|
28
|
-
Run this command to install the CLI tool globally:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
# Stable version
|
|
32
|
-
npm install -g @relipa/ai-flow-kit
|
|
33
|
-
|
|
34
|
-
# Beta version (recommend for newest features)
|
|
35
|
-
npm install -g @relipa/ai-flow-kit@beta
|
|
36
|
-
|
|
37
|
-
# Verification
|
|
38
|
-
aiflow --version
|
|
39
|
-
|
|
40
|
-
# Uninstall
|
|
41
|
-
npm uninstall -g @relipa/ai-flow-kit
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
## 4. First-time Setup
|
|
46
|
-
|
|
47
|
-
In your project root, run:
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
aiflow init --framework [your-framework] --adapter [backlog/jira]
|
|
51
|
-
```
|
|
52
|
-
*Example: `aiflow init --framework nestjs --adapter backlog`*
|
|
53
|
-
|
|
54
|
-
**What this does:**
|
|
55
|
-
1. Verifies your API keys.
|
|
56
|
-
2. Creates instruction files: `CLAUDE.md`, `.cursorrules`, `GEMINI.md`.
|
|
57
|
-
3. Installs "Superpowers" skills.
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
## 5. Daily Task Workflow (The 5 Gates)
|
|
62
|
-
|
|
63
|
-
### Step 1: Start a Task
|
|
64
|
-
Load the ticket context from your issue tracker:
|
|
65
|
-
```bash
|
|
66
|
-
aiflow use PROJ-33
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
### Step 2: Open your AI Tool
|
|
70
|
-
- **Claude Code**: Type `claude`. The AI will automatically start **Gate 1**.
|
|
71
|
-
- **Cursor**: Just start chatting with Cursor. It will detect the active ticket and start analyzing.
|
|
72
|
-
|
|
73
|
-
### Step 3: Follow the Gates
|
|
74
|
-
The AI *must* pass each gate in order. You act as the **Reviewer**.
|
|
75
|
-
|
|
76
|
-
1. **⛩️ Gate 1: Requirement Analysis**
|
|
77
|
-
- AI reads code + ticket.
|
|
78
|
-
- AI outputs `plan/PROJ-33/requirement.md`.
|
|
79
|
-
- **Your Action**: Read the doc. If OK, type `APPROVED`.
|
|
80
|
-
|
|
81
|
-
2. **⛩️ Gate 2: Implementation Plan**
|
|
82
|
-
- AI creates a step-by-step TDD plan.
|
|
83
|
-
- **Your Action**: Type `APPROVED` to start coding.
|
|
84
|
-
|
|
85
|
-
3. **⛩️ Gate 3: Coding (TDD)**
|
|
86
|
-
- AI writes tests first, then code.
|
|
87
|
-
- **Your Action**: Monitor.
|
|
88
|
-
|
|
89
|
-
4. **⛩️ Gate 4: Self-Review**
|
|
90
|
-
- AI verifies tests and checks a review-checklist.
|
|
91
|
-
- **Your Action**: Review the final diff. If OK, type `APPROVED`.
|
|
92
|
-
|
|
93
|
-
5. **⛩️ Gate 5: Pull Request**
|
|
94
|
-
- AI helps you write a detailed PR description.
|
|
95
|
-
- **Your Action**: Create the PR and ask for a peer review.
|
|
96
|
-
|
|
97
|
-
---
|
|
98
|
-
|
|
99
|
-
## 6. Switching AI Tools Mid-Task
|
|
100
|
-
|
|
101
|
-
You can switch tools at any time because the "brain" (the State) is stored in your project files.
|
|
102
|
-
|
|
103
|
-
**Example Scenario:**
|
|
104
|
-
1. Use **Claude Code CLI** for **Gate 1** (Analysis) because it's great at exploring many files.
|
|
105
|
-
2. Once you type `APPROVED`, close Claude.
|
|
106
|
-
3. Open **Cursor** for **Gate 3** (Coding) to take advantage of its excellent editor integration. Cursor will see you've already finished the analysis and will continue from the plan.
|
|
107
|
-
|
|
108
|
-
---
|
|
109
|
-
|
|
110
|
-
## 7. Best Practices
|
|
111
|
-
|
|
112
|
-
- **One question at a time**: If the AI asks 5 questions, answer them one by one or ignore the irrelevant ones.
|
|
113
|
-
- **Small commits**: Let the AI commit frequently (default behavior).
|
|
114
|
-
- **Be the Pilot**: The AI is your co-pilot. If its solution looks over-engineered, tell it: *"Simplify this by using [X] pattern"*.
|
|
115
|
-
|
|
116
|
-
---
|
|
117
|
-
|
|
118
|
-
## 8. Troubleshooting
|
|
119
|
-
|
|
120
|
-
- **AI is stuck**: Type `reset context` or use `aiflow doctor` to check setup.
|
|
121
|
-
- **Credentials fail**: Re-run `aiflow init --adapter backlog` to update keys.
|
|
122
|
-
- **Rules not followed**: Remind the AI: *"Follow the rules in CLAUDE.md"*.
|
|
123
|
-
|
|
124
|
-
---
|
|
125
|
-
|
|
126
|
-
**Happy Coding!** สำหรับรายละเอียดเชิงลึก โปรดดู [AIFLOW.md](../AIFLOW.md).
|
|
1
|
+
# AI Flow Kit — Developer Rollout Guide
|
|
2
|
+
|
|
3
|
+
Welcome to the **AI Flow Kit**! This guide is designed to get you up and running with our standardized AI development workflow.
|
|
4
|
+
|
|
5
|
+
## 1. What is AI Flow Kit?
|
|
6
|
+
|
|
7
|
+
It's a "Zero-Config" framework for AI-assisted development. It automatically:
|
|
8
|
+
- Pulls ticket context (requirements, comments) from Backlog/Jira.
|
|
9
|
+
- Orchestrates a **5-Gate Workflow** (Analyze → Plan → Code → Review → PR).
|
|
10
|
+
- Enforces team coding standards and architecture rules.
|
|
11
|
+
- Synchronizes state across different AI tools (Claude, Cursor, Gemini).
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 2. Prerequisites
|
|
16
|
+
|
|
17
|
+
Before starting, ensure you have:
|
|
18
|
+
1. **Node.js** (v18 or higher).
|
|
19
|
+
2. **AI Tool(s)**:
|
|
20
|
+
- **Claude Code CLI** (Recommended for analysis and heavy tasks).
|
|
21
|
+
- **Cursor AI** (Recommended for coding and UI work).
|
|
22
|
+
- **Gemini CLI** or **GitHub Copilot** (Alternative options).
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## 3. Installation
|
|
27
|
+
|
|
28
|
+
Run this command to install the CLI tool globally:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
# Stable version
|
|
32
|
+
npm install -g @relipa/ai-flow-kit
|
|
33
|
+
|
|
34
|
+
# Beta version (recommend for newest features)
|
|
35
|
+
npm install -g @relipa/ai-flow-kit@beta
|
|
36
|
+
|
|
37
|
+
# Verification
|
|
38
|
+
aiflow --version
|
|
39
|
+
|
|
40
|
+
# Uninstall
|
|
41
|
+
npm uninstall -g @relipa/ai-flow-kit
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## 4. First-time Setup
|
|
46
|
+
|
|
47
|
+
In your project root, run:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
aiflow init --framework [your-framework] --adapter [backlog/jira]
|
|
51
|
+
```
|
|
52
|
+
*Example: `aiflow init --framework nestjs --adapter backlog`*
|
|
53
|
+
|
|
54
|
+
**What this does:**
|
|
55
|
+
1. Verifies your API keys.
|
|
56
|
+
2. Creates instruction files: `CLAUDE.md`, `.cursorrules`, `GEMINI.md`.
|
|
57
|
+
3. Installs "Superpowers" skills.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 5. Daily Task Workflow (The 5 Gates)
|
|
62
|
+
|
|
63
|
+
### Step 1: Start a Task
|
|
64
|
+
Load the ticket context from your issue tracker:
|
|
65
|
+
```bash
|
|
66
|
+
aiflow use PROJ-33
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Step 2: Open your AI Tool
|
|
70
|
+
- **Claude Code**: Type `claude`. The AI will automatically start **Gate 1**.
|
|
71
|
+
- **Cursor**: Just start chatting with Cursor. It will detect the active ticket and start analyzing.
|
|
72
|
+
|
|
73
|
+
### Step 3: Follow the Gates
|
|
74
|
+
The AI *must* pass each gate in order. You act as the **Reviewer**.
|
|
75
|
+
|
|
76
|
+
1. **⛩️ Gate 1: Requirement Analysis**
|
|
77
|
+
- AI reads code + ticket.
|
|
78
|
+
- AI outputs `plan/PROJ-33/requirement.md`.
|
|
79
|
+
- **Your Action**: Read the doc. If OK, type `APPROVED`.
|
|
80
|
+
|
|
81
|
+
2. **⛩️ Gate 2: Implementation Plan**
|
|
82
|
+
- AI creates a step-by-step TDD plan.
|
|
83
|
+
- **Your Action**: Type `APPROVED` to start coding.
|
|
84
|
+
|
|
85
|
+
3. **⛩️ Gate 3: Coding (TDD)**
|
|
86
|
+
- AI writes tests first, then code.
|
|
87
|
+
- **Your Action**: Monitor.
|
|
88
|
+
|
|
89
|
+
4. **⛩️ Gate 4: Self-Review**
|
|
90
|
+
- AI verifies tests and checks a review-checklist.
|
|
91
|
+
- **Your Action**: Review the final diff. If OK, type `APPROVED`.
|
|
92
|
+
|
|
93
|
+
5. **⛩️ Gate 5: Pull Request**
|
|
94
|
+
- AI helps you write a detailed PR description.
|
|
95
|
+
- **Your Action**: Create the PR and ask for a peer review.
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## 6. Switching AI Tools Mid-Task
|
|
100
|
+
|
|
101
|
+
You can switch tools at any time because the "brain" (the State) is stored in your project files.
|
|
102
|
+
|
|
103
|
+
**Example Scenario:**
|
|
104
|
+
1. Use **Claude Code CLI** for **Gate 1** (Analysis) because it's great at exploring many files.
|
|
105
|
+
2. Once you type `APPROVED`, close Claude.
|
|
106
|
+
3. Open **Cursor** for **Gate 3** (Coding) to take advantage of its excellent editor integration. Cursor will see you've already finished the analysis and will continue from the plan.
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## 7. Best Practices
|
|
111
|
+
|
|
112
|
+
- **One question at a time**: If the AI asks 5 questions, answer them one by one or ignore the irrelevant ones.
|
|
113
|
+
- **Small commits**: Let the AI commit frequently (default behavior).
|
|
114
|
+
- **Be the Pilot**: The AI is your co-pilot. If its solution looks over-engineered, tell it: *"Simplify this by using [X] pattern"*.
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## 8. Troubleshooting
|
|
119
|
+
|
|
120
|
+
- **AI is stuck**: Type `reset context` or use `aiflow doctor` to check setup.
|
|
121
|
+
- **Credentials fail**: Re-run `aiflow init --adapter backlog` to update keys.
|
|
122
|
+
- **Rules not followed**: Remind the AI: *"Follow the rules in CLAUDE.md"*.
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
**Happy Coding!** สำหรับรายละเอียดเชิงลึก โปรดดู [AIFLOW.md](../AIFLOW.md).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@relipa/ai-flow-kit",
|
|
3
|
-
"version": "0.0.4
|
|
3
|
+
"version": "0.0.4",
|
|
4
4
|
"description": "All-in-one AI Flow Kit for team development with Claude AI - skills, templates, and MCP adapters",
|
|
5
5
|
"author": "Relipa AI Team",
|
|
6
6
|
"publishConfig": {
|
|
@@ -20,13 +20,7 @@
|
|
|
20
20
|
"upstream",
|
|
21
21
|
"docs",
|
|
22
22
|
"package.json",
|
|
23
|
-
"index.js"
|
|
24
|
-
"README.md",
|
|
25
|
-
"QUICK_START.md",
|
|
26
|
-
"AIFLOW.md",
|
|
27
|
-
"CONTRIBUTING.md",
|
|
28
|
-
"IMPLEMENTATION_SUMMARY.md",
|
|
29
|
-
"CHANGELOG.md"
|
|
23
|
+
"index.js"
|
|
30
24
|
],
|
|
31
25
|
"keywords": [
|
|
32
26
|
"ai",
|