@relipa/ai-flow-kit 0.0.4-beta.0 → 0.0.4-beta.3
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/AIFLOW.md +2 -2
- package/CHANGELOG.md +4 -1
- package/QUICK_START.md +14 -4
- package/README.md +20 -1
- package/bin/aiflow.js +5 -0
- package/custom/skills/investigate-bug/SKILL.md +1 -1
- package/custom/skills/validate-ticket/SKILL.md +1 -1
- package/custom/templates/shared/gate-workflow.md +5 -2
- package/custom/templates/tools/copilot.md +3 -1
- package/custom/templates/tools/cursor.md +3 -1
- package/custom/templates/tools/gemini.md +3 -1
- package/custom/templates/tools/generic.md +3 -1
- package/docs/ai-integration.md +2 -2
- package/docs/architecture.md +1 -1
- package/docs/cli-reference.md +2 -2
- package/docs/developer-overview.md +8 -4
- package/docs/troubleshooting.md +1 -1
- package/package.json +1 -1
- package/scripts/hooks/session-start.js +3 -2
- package/scripts/init.js +460 -491
- package/scripts/prompt.js +1 -1
- package/scripts/use.js +594 -570
package/AIFLOW.md
CHANGED
|
@@ -83,7 +83,7 @@ claude # open Claude → AI auto-starts Gate 1
|
|
|
83
83
|
|
|
84
84
|
| Step | Action | Purpose |
|
|
85
85
|
|------|--------|---------|
|
|
86
|
-
| 1 | Load ticket from `.
|
|
86
|
+
| 1 | Load ticket from `.aiflow/context/current.json` | Get PM's requirements, comments |
|
|
87
87
|
| 2 | Read `CLAUDE.md` + source code | Understand architecture, tech stack, patterns |
|
|
88
88
|
| 3 | Investigate related files & data flow | Identify affected areas, dependencies |
|
|
89
89
|
| 4 | Ask clarifying questions (one at a time) | Ensure full understanding |
|
|
@@ -415,7 +415,7 @@ aiflow guide # view quickstart guide
|
|
|
415
415
|
|
|
416
416
|
## Multi-AI Environment Setup
|
|
417
417
|
|
|
418
|
-
One of the core strengths of `ai-flow-kit` is that the **Gate Workflow** is tool-agnostic. Since state is saved in `.
|
|
418
|
+
One of the core strengths of `ai-flow-kit` is that the **Gate Workflow** is tool-agnostic. Since state is saved in `.aiflow/context/current.json` and the `plan/` directory, you can switch tools mid-task.
|
|
419
419
|
|
|
420
420
|
### How to Switch Tools
|
|
421
421
|
1. **Analyze (Gate 1)** using Claude Code CLI (great for deep codebase scans).
|
package/CHANGELOG.md
CHANGED
|
@@ -9,7 +9,10 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
9
9
|
|
|
10
10
|
## [Unreleased]
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
### Changed
|
|
13
|
+
- Neutralized project structure by moving shared ticket context to `.aiflow/context/current.json`.
|
|
14
|
+
- Updated all AI templates (Claude, Cursor, Gemini, Copilot) to point to the new shared context location.
|
|
15
|
+
- Updated `aiflow use` and `aiflow prompt` to work with the new neutral path.
|
|
13
16
|
|
|
14
17
|
---
|
|
15
18
|
|
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
|
---
|
|
@@ -94,7 +103,7 @@ claude # AI auto-starts Gate 1 immediately
|
|
|
94
103
|
> **Multi-Tool Support:**
|
|
95
104
|
> - If using **Cursor**: Gate Workflow is enforced via `.cursorrules`.
|
|
96
105
|
> - If using **Gemini CLI**: Rules are loaded from `GEMINI.md`.
|
|
97
|
-
> - The AI will automatically detect if you are mid-task by reading `.
|
|
106
|
+
> - The AI will automatically detect if you are mid-task by reading `.aiflow/context/current.json`.
|
|
98
107
|
|
|
99
108
|
### Step 3: GATE 1 — AI Analyzes Requirement
|
|
100
109
|
|
|
@@ -102,7 +111,7 @@ claude # AI auto-starts Gate 1 immediately
|
|
|
102
111
|
|
|
103
112
|
When you open Claude, AI will **automatically** start analyzing:
|
|
104
113
|
|
|
105
|
-
1. **Read ticket** from `.
|
|
114
|
+
1. **Read ticket** from `.aiflow/context/current.json`
|
|
106
115
|
2. **Read source code** — understand architecture, related files, data flow
|
|
107
116
|
3. **Ask clarifying questions** (one at a time) if anything is unclear
|
|
108
117
|
4. **Output** `plan/PROJ-33/requirement.md` containing:
|
|
@@ -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
|
---
|
|
@@ -135,7 +154,7 @@ aiflow init --framework spring-boot,reactjs --adapter backlog,jira
|
|
|
135
154
|
|
|
136
155
|
### `aiflow use <ticket>`
|
|
137
156
|
|
|
138
|
-
Load ticket context into `.
|
|
157
|
+
Load ticket context into `.aiflow/context/current.json`.
|
|
139
158
|
|
|
140
159
|
```bash
|
|
141
160
|
# Backlog
|
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
|
|
|
@@ -24,7 +24,7 @@ keywords: bug, fix, error, crash, broken
|
|
|
24
24
|
|
|
25
25
|
### 1. Read context from ticket (if available)
|
|
26
26
|
|
|
27
|
-
Check `.
|
|
27
|
+
Check `.aiflow/context/current.json`:
|
|
28
28
|
- `description` — bug description from the ticket
|
|
29
29
|
- `comments` — discussions, additional info
|
|
30
30
|
- `context.files` — related files mentioned
|
|
@@ -16,7 +16,7 @@ keywords: ticket, validate, context, requirement, backlog, jira, analyze, unders
|
|
|
16
16
|
|
|
17
17
|
### Step 1: Load Ticket & Read Source Code
|
|
18
18
|
|
|
19
|
-
1. Read `.
|
|
19
|
+
1. Read `.aiflow/context/current.json` — ticket info from Backlog/Jira
|
|
20
20
|
2. Read `CLAUDE.md` — understand project architecture, tech stack, conventions
|
|
21
21
|
3. Read related source files — trace data flow, identify patterns, dependencies
|
|
22
22
|
4. Read ticket comments — additional context from PM/team
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
> **Absolute Rule: Complete Gate N before entering Gate N+1.**
|
|
4
4
|
> **Do not skip, shorten, or merge Gates.**
|
|
5
5
|
|
|
6
|
-
You have superpowers. When a ticket context exists in `.
|
|
6
|
+
You have superpowers. When a ticket context exists in `.aiflow/context/current.json`:
|
|
7
7
|
- **AUTO-START Gate 1 immediately** — do NOT wait for the developer to ask.
|
|
8
8
|
- Read instructions and follow the gate sequence below — NO EXCEPTIONS.
|
|
9
9
|
|
|
@@ -14,7 +14,7 @@ You have superpowers. When a ticket context exists in `.claude/context/current.j
|
|
|
14
14
|
**INVOKE:** `validate-ticket` skill
|
|
15
15
|
|
|
16
16
|
AI actively reads ticket + source code to understand the requirement:
|
|
17
|
-
1. Read `.
|
|
17
|
+
1. Read `.aiflow/context/current.json` — ticket info
|
|
18
18
|
2. Read source code — architecture, related files, data flow
|
|
19
19
|
3. If anything is unclear — ask ONE question at a time, wait for reply
|
|
20
20
|
4. Output `plan/[ticket-id]/requirement.md` with:
|
|
@@ -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
|
---
|
|
@@ -3,4 +3,6 @@
|
|
|
3
3
|
You are an expert AI assistant specialized in this project's stack. Follow the Gate Workflow and Team Rules strictly.
|
|
4
4
|
|
|
5
5
|
> [!IMPORTANT]
|
|
6
|
-
> Always check for context in `.
|
|
6
|
+
> Always check for context in `.aiflow/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"**.
|
|
@@ -3,4 +3,6 @@
|
|
|
3
3
|
You are an expert AI assistant specialized in this project's stack. Follow the Gate Workflow and Team Rules strictly.
|
|
4
4
|
|
|
5
5
|
> [!IMPORTANT]
|
|
6
|
-
> Always check `.
|
|
6
|
+
> Always check `.aiflow/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"**.
|
|
@@ -3,4 +3,6 @@
|
|
|
3
3
|
You are an expert AI assistant specialized in this project's stack. Follow the Gate Workflow and Team Rules strictly.
|
|
4
4
|
|
|
5
5
|
> [!IMPORTANT]
|
|
6
|
-
> When starting a session, always read `.
|
|
6
|
+
> When starting a session, always read `.aiflow/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.
|
|
@@ -3,8 +3,10 @@
|
|
|
3
3
|
You are an expert AI assistant. Follow the project's Gate Workflow and Team Rules strictly.
|
|
4
4
|
|
|
5
5
|
## Context Awareness
|
|
6
|
-
- **Ticket context**: `.
|
|
6
|
+
- **Ticket context**: `.aiflow/context/current.json`
|
|
7
7
|
- **Task progress**: `plan/[ticket-id]/`
|
|
8
8
|
- **Rules**: `.rules/`
|
|
9
9
|
|
|
10
10
|
Follow the gated workflow and rules defined below.
|
|
11
|
+
|
|
12
|
+
If Gate 1 does not start automatically, please start it when the developer types **"Gate 1"**.
|
package/docs/ai-integration.md
CHANGED
|
@@ -24,7 +24,7 @@ When you run `aiflow init`, it generates a `.cursorrules` file.
|
|
|
24
24
|
|
|
25
25
|
### 2. Gemini CLI
|
|
26
26
|
Pass `GEMINI.md` as system instructions to your Gemini session.
|
|
27
|
-
- **Tip**: Always ensure the AI reads `.
|
|
27
|
+
- **Tip**: Always ensure the AI reads `.aiflow/context/current.json` first to load the ticket context.
|
|
28
28
|
- Gemini is excellent for large context analysis during Gate 1.
|
|
29
29
|
|
|
30
30
|
### 3. GitHub Copilot / Codex
|
|
@@ -36,7 +36,7 @@ Copilot uses `.github/copilot-instructions.md` to guide its suggestions.
|
|
|
36
36
|
## Cross-Tool State Resumption
|
|
37
37
|
The "Secret Sauce" of `ai-flow-kit` is its file-based state management:
|
|
38
38
|
|
|
39
|
-
1. **Context**: Saved in `.
|
|
39
|
+
1. **Context**: Saved in `.aiflow/context/current.json`.
|
|
40
40
|
2. **Progress**: Saved as Markdown docs in `plan/[ticket-id]/`.
|
|
41
41
|
3. **Rules**: Saved in `.rules/`.
|
|
42
42
|
|
package/docs/architecture.md
CHANGED
package/docs/cli-reference.md
CHANGED
|
@@ -80,7 +80,7 @@ aiflow use 1.0.0
|
|
|
80
80
|
**What it does:**
|
|
81
81
|
1. Fetches context from MCP adapter (if applicable)
|
|
82
82
|
2. Parses and validates context
|
|
83
|
-
3. Saves to `.
|
|
83
|
+
3. Saves to `.aiflow/context/current.json`
|
|
84
84
|
4. Updates state tracking
|
|
85
85
|
|
|
86
86
|
**Example:**
|
|
@@ -90,7 +90,7 @@ Fetching context from Jira...
|
|
|
90
90
|
✓ Title: Fix payment processing error
|
|
91
91
|
✓ Description: 2000+ words pulled
|
|
92
92
|
✓ Acceptance criteria: 3 items
|
|
93
|
-
✓ Saved to .
|
|
93
|
+
✓ Saved to .aiflow/context/current.json
|
|
94
94
|
|
|
95
95
|
Ready to prompt! Run: aiflow prompt bug-fix
|
|
96
96
|
```
|
|
@@ -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/docs/troubleshooting.md
CHANGED
package/package.json
CHANGED
|
@@ -14,7 +14,7 @@ const path = require('path');
|
|
|
14
14
|
// Project root is 3 levels up
|
|
15
15
|
const projectRoot = path.resolve(__dirname, '..', '..', '..');
|
|
16
16
|
const skillPath = path.join(projectRoot, '.claude', 'skills', 'using-superpowers', 'SKILL.md');
|
|
17
|
-
const contextPath = path.join(projectRoot, '.
|
|
17
|
+
const contextPath = path.join(projectRoot, '.aiflow', 'context', 'current.json');
|
|
18
18
|
|
|
19
19
|
// ── 1. Load superpowers skill ──────────────────────────────────
|
|
20
20
|
let skillContent = '';
|
|
@@ -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
|
+
}
|