@relipa/ai-flow-kit 0.0.4-beta.0 → 0.0.4-beta.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/QUICK_START.md +12 -2
- package/README.md +19 -0
- package/bin/aiflow.js +5 -0
- package/custom/templates/shared/gate-workflow.md +3 -0
- package/custom/templates/tools/copilot.md +2 -0
- package/custom/templates/tools/cursor.md +2 -0
- package/custom/templates/tools/gemini.md +2 -0
- package/custom/templates/tools/generic.md +2 -0
- package/docs/developer-overview.md +8 -4
- package/package.json +1 -1
- package/scripts/hooks/session-start.js +2 -1
- package/scripts/init.js +460 -491
- package/scripts/use.js +594 -570
package/QUICK_START.md
CHANGED
|
@@ -7,8 +7,17 @@
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
+
# Stable version
|
|
10
11
|
npm install -g @relipa/ai-flow-kit
|
|
12
|
+
|
|
13
|
+
# Beta version (recommend for newest features)
|
|
14
|
+
npm install -g @relipa/ai-flow-kit@beta
|
|
15
|
+
|
|
16
|
+
# Verification
|
|
11
17
|
aiflow --version
|
|
18
|
+
|
|
19
|
+
# Uninstall
|
|
20
|
+
npm uninstall -g @relipa/ai-flow-kit
|
|
12
21
|
```
|
|
13
22
|
|
|
14
23
|
---
|
|
@@ -323,8 +332,9 @@ aiflow guide --commands # command reference
|
|
|
323
332
|
|
|
324
333
|
# Maintenance
|
|
325
334
|
aiflow remove # remove from project
|
|
326
|
-
aiflow remove --global # uninstall globally
|
|
327
|
-
aiflow remove --version 1.0.0 # remove cached version
|
|
335
|
+
aiflow remove --global # uninstall globally (npm uninstall -g)
|
|
336
|
+
aiflow remove --version 1.0.0 # remove cached version from .aiflow/
|
|
337
|
+
npm uninstall -g @relipa/ai-flow-kit # standard npm uninstall
|
|
328
338
|
```
|
|
329
339
|
|
|
330
340
|
---
|
package/README.md
CHANGED
|
@@ -18,6 +18,18 @@ Developers only need a single command to load ticket context → AI automaticall
|
|
|
18
18
|
| Missing impact analysis flow | Skill `impact-analysis` |
|
|
19
19
|
| Hard to resume tasks | **State Resumption**: Unified `plan/` docs and context across tools |
|
|
20
20
|
|
|
21
|
+
## Documentation & Guides
|
|
22
|
+
|
|
23
|
+
> [!TIP]
|
|
24
|
+
> After running `aiflow init`, all documentation files are automatically copied to your project root and `.aiflow/docs/` for easy access.
|
|
25
|
+
|
|
26
|
+
- **[Quick Start Guide](./QUICK_START.md)** — Step-by-step instructions for developers.
|
|
27
|
+
- **[Full Workflow (5 Gates)](./AIFLOW.md)** — In-depth look at the Gate process.
|
|
28
|
+
- **[Developer Onboarding](./docs/developer-overview.md)** — Presentation-ready guide for new team members.
|
|
29
|
+
- **[Contributing Guide](./CONTRIBUTING.md)** — How to extend with new skills/templates.
|
|
30
|
+
- **[Troubleshooting](./docs/troubleshooting.md)** — Common issues and fixes.
|
|
31
|
+
- **[Integration Guide](./docs/ai-integration.md)** — Advanced tool setup (Claude, Cursor, Gemini).
|
|
32
|
+
|
|
21
33
|
---
|
|
22
34
|
|
|
23
35
|
## Overview Flow
|
|
@@ -92,7 +104,14 @@ Developers only need a single command to load ticket context → AI automaticall
|
|
|
92
104
|
## Installation
|
|
93
105
|
|
|
94
106
|
```bash
|
|
107
|
+
# Stable version
|
|
95
108
|
npm install -g @relipa/ai-flow-kit
|
|
109
|
+
|
|
110
|
+
# Beta version (recommend for newest features)
|
|
111
|
+
npm install -g @relipa/ai-flow-kit@beta
|
|
112
|
+
|
|
113
|
+
# Uninstall
|
|
114
|
+
npm uninstall -g @relipa/ai-flow-kit
|
|
96
115
|
```
|
|
97
116
|
|
|
98
117
|
---
|
package/bin/aiflow.js
CHANGED
|
@@ -25,6 +25,7 @@ program
|
|
|
25
25
|
.description('Initialize AI Flow Kit in your project')
|
|
26
26
|
.option('-f, --framework <types>', 'framework(s), comma-separated (e.g. spring-boot,reactjs)')
|
|
27
27
|
.option('-a, --adapter <types>', 'adapter(s), comma-separated (e.g. backlog,jira)')
|
|
28
|
+
.option('-e, --env <types>', 'AI environment(s)/tool(s), comma-separated (e.g. cursor,gemini,copilot)')
|
|
28
29
|
.action((options) => {
|
|
29
30
|
options.frameworks = options.framework
|
|
30
31
|
? options.framework.split(',').map(s => s.trim()).filter(Boolean)
|
|
@@ -32,6 +33,10 @@ program
|
|
|
32
33
|
options.adapters = options.adapter
|
|
33
34
|
? options.adapter.split(',').map(s => s.trim()).filter(Boolean)
|
|
34
35
|
: [];
|
|
36
|
+
options.aiTools = options.env
|
|
37
|
+
? options.env.split(',').map(s => s.trim()).filter(Boolean)
|
|
38
|
+
: Object.keys(require('../scripts/init').AI_TOOL_FILES || {});
|
|
39
|
+
|
|
35
40
|
initCommand(options);
|
|
36
41
|
});
|
|
37
42
|
|
|
@@ -23,6 +23,9 @@ AI actively reads ticket + source code to understand the requirement:
|
|
|
23
23
|
- Impact analysis, effort estimate, testing plan
|
|
24
24
|
5. Display "GATE 1: Requirement doc ready" → wait for **APPROVED**
|
|
25
25
|
|
|
26
|
+
> [!TIP]
|
|
27
|
+
> If auto-start doesn't trigger, the developer can start this gate by typing: **"start"**, **"Gate 1"** or **"Analyze ticket"**.
|
|
28
|
+
|
|
26
29
|
DO NOT just check format — **understand the content and propose solutions**.
|
|
27
30
|
|
|
28
31
|
---
|
|
@@ -4,3 +4,5 @@ You are an expert AI assistant specialized in this project's stack. Follow the G
|
|
|
4
4
|
|
|
5
5
|
> [!IMPORTANT]
|
|
6
6
|
> Always check for context in `.claude/context/current.json` and progress in the `plan/` folder before suggesting changes.
|
|
7
|
+
|
|
8
|
+
If the Gate Workflow hasn't started, wait for the developer to type **"start"** or **"Gate 1"**.
|
|
@@ -4,3 +4,5 @@ You are an expert AI assistant specialized in this project's stack. Follow the G
|
|
|
4
4
|
|
|
5
5
|
> [!IMPORTANT]
|
|
6
6
|
> Always check `.claude/context/current.json` and the `plan/` directory before starting any task to understand current context and progress.
|
|
7
|
+
|
|
8
|
+
If Gate 1 doesn't auto-start, wait for the developer to type **"start"**, **"Gate 1"** or **"Analyze ticket"**.
|
|
@@ -4,3 +4,5 @@ You are an expert AI assistant specialized in this project's stack. Follow the G
|
|
|
4
4
|
|
|
5
5
|
> [!IMPORTANT]
|
|
6
6
|
> When starting a session, always read `.claude/context/current.json` to load ticket context and check the `plan/` directory for existing progress.
|
|
7
|
+
|
|
8
|
+
If no instructions are automatically followed, wait for the developer to type **"start"** or **"Gate 1"** to start the analysis.
|
|
@@ -28,13 +28,17 @@ Before starting, ensure you have:
|
|
|
28
28
|
Run this command to install the CLI tool globally:
|
|
29
29
|
|
|
30
30
|
```bash
|
|
31
|
+
# Stable version
|
|
31
32
|
npm install -g @relipa/ai-flow-kit
|
|
32
|
-
```
|
|
33
33
|
|
|
34
|
-
|
|
35
|
-
|
|
34
|
+
# Beta version (recommend for newest features)
|
|
35
|
+
npm install -g @relipa/ai-flow-kit@beta
|
|
36
|
+
|
|
37
|
+
# Verification
|
|
36
38
|
aiflow --version
|
|
37
|
-
|
|
39
|
+
|
|
40
|
+
# Uninstall
|
|
41
|
+
npm uninstall -g @relipa/ai-flow-kit
|
|
38
42
|
|
|
39
43
|
---
|
|
40
44
|
|
package/package.json
CHANGED
|
@@ -134,7 +134,8 @@ function buildContextPrompt(ctx) {
|
|
|
134
134
|
lines.push('6. Display GATE 1 prompt and wait for APPROVED');
|
|
135
135
|
lines.push('');
|
|
136
136
|
lines.push('DO NOT wait for the developer to ask. START NOW.');
|
|
137
|
+
lines.push('If you have not started automatically, begin as soon as the developer types **"start"**.');
|
|
137
138
|
lines.push('</ACTIVE_TASK>');
|
|
138
139
|
|
|
139
140
|
return lines.join('\n');
|
|
140
|
-
}
|
|
141
|
+
}
|