ai-sprint-kit 1.1.0 → 1.1.5
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/LICENSE +135 -0
- package/README.md +146 -220
- package/package.json +6 -6
- package/templates/.claude/commands/scan.md +2 -2
- package/templates/.claude/skills/codebase-context/references/refresh-triggers.md +2 -2
- package/templates/README.md +2 -2
- package/templates/docs/user-guide-th.md +1 -1
- package/templates/docs/user-guide.md +2 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# PolyForm Noncommercial License 1.0.0
|
|
2
|
+
|
|
3
|
+
<https://polyformproject.org/licenses/noncommercial/1.0.0>
|
|
4
|
+
|
|
5
|
+
## Acceptance
|
|
6
|
+
|
|
7
|
+
In order to get any license under these terms, you must agree
|
|
8
|
+
to them as both strict obligations and conditions to all
|
|
9
|
+
your licenses.
|
|
10
|
+
|
|
11
|
+
## Copyright License
|
|
12
|
+
|
|
13
|
+
The licensor grants you a copyright license for the
|
|
14
|
+
software to do everything you might do with the software
|
|
15
|
+
that would otherwise infringe the licensor's copyright
|
|
16
|
+
in it for any permitted purpose. However, you may
|
|
17
|
+
only distribute the software according to [Distribution
|
|
18
|
+
License](#distribution-license) and make changes or new works
|
|
19
|
+
based on the software according to [Changes and New Works
|
|
20
|
+
License](#changes-and-new-works-license).
|
|
21
|
+
|
|
22
|
+
## Distribution License
|
|
23
|
+
|
|
24
|
+
The licensor grants you an additional copyright license
|
|
25
|
+
to distribute copies of the software. Your license
|
|
26
|
+
to distribute covers distributing the software with
|
|
27
|
+
changes and new works permitted by [Changes and New Works
|
|
28
|
+
License](#changes-and-new-works-license).
|
|
29
|
+
|
|
30
|
+
## Notices
|
|
31
|
+
|
|
32
|
+
You must ensure that anyone who gets a copy of any part of
|
|
33
|
+
the software from you also gets a copy of these terms or the
|
|
34
|
+
URL for them above, as well as copies of any plain-text lines
|
|
35
|
+
beginning with `Required Notice:` that the licensor provided
|
|
36
|
+
with the software. For example:
|
|
37
|
+
|
|
38
|
+
> Required Notice: Copyright Apiasak Pungpapong (https://github.com/apiasak)
|
|
39
|
+
|
|
40
|
+
## Changes and New Works License
|
|
41
|
+
|
|
42
|
+
The licensor grants you an additional copyright license to
|
|
43
|
+
make changes and new works based on the software for any
|
|
44
|
+
permitted purpose.
|
|
45
|
+
|
|
46
|
+
## Patent License
|
|
47
|
+
|
|
48
|
+
The licensor grants you a patent license for the software that
|
|
49
|
+
covers patent claims the licensor can license, or becomes able
|
|
50
|
+
to license, that you would infringe by using the software.
|
|
51
|
+
|
|
52
|
+
## Noncommercial Purposes
|
|
53
|
+
|
|
54
|
+
Any noncommercial purpose is a permitted purpose.
|
|
55
|
+
|
|
56
|
+
## Personal Uses
|
|
57
|
+
|
|
58
|
+
Personal use for research, experiment, and testing for
|
|
59
|
+
the benefit of public knowledge, personal study, private
|
|
60
|
+
entertainment, hobby projects, amateur pursuits, or religious
|
|
61
|
+
observance, without any anticipated commercial application,
|
|
62
|
+
is use for a permitted purpose.
|
|
63
|
+
|
|
64
|
+
## Noncommercial Organizations
|
|
65
|
+
|
|
66
|
+
Use by any charitable organization, educational institution,
|
|
67
|
+
public research organization, public safety or health
|
|
68
|
+
organization, environmental protection organization,
|
|
69
|
+
or government institution is use for a permitted purpose
|
|
70
|
+
regardless of the source of funding or obligations resulting
|
|
71
|
+
from the funding.
|
|
72
|
+
|
|
73
|
+
## Fair Use
|
|
74
|
+
|
|
75
|
+
You may have "fair use" rights for the software under the
|
|
76
|
+
law. These terms do not limit them.
|
|
77
|
+
|
|
78
|
+
## No Other Rights
|
|
79
|
+
|
|
80
|
+
These terms do not allow you to sublicense or transfer any of
|
|
81
|
+
your licenses to anyone else, or prevent the licensor from
|
|
82
|
+
granting licenses to anyone else. These terms do not imply
|
|
83
|
+
any other licenses.
|
|
84
|
+
|
|
85
|
+
## Patent Defense
|
|
86
|
+
|
|
87
|
+
If you make any written claim that the software infringes or
|
|
88
|
+
contributes to infringement of any patent, your patent license
|
|
89
|
+
for the software granted under these terms ends immediately. If
|
|
90
|
+
your company makes such a claim, your patent license ends
|
|
91
|
+
immediately for work on behalf of your company.
|
|
92
|
+
|
|
93
|
+
## Violations
|
|
94
|
+
|
|
95
|
+
The first time you are notified in writing that you have
|
|
96
|
+
violated any of these terms, or done anything with the software
|
|
97
|
+
not covered by your licenses, your licenses can nonetheless
|
|
98
|
+
continue if you come into full compliance with these terms,
|
|
99
|
+
and take practical steps to correct past violations, within
|
|
100
|
+
32 days of receiving notice. Otherwise, all your licenses
|
|
101
|
+
end immediately.
|
|
102
|
+
|
|
103
|
+
## No Liability
|
|
104
|
+
|
|
105
|
+
***As far as the law allows, the software comes as is, without
|
|
106
|
+
any warranty or condition, and the licensor will not be liable
|
|
107
|
+
to you for any damages arising out of these terms or the use
|
|
108
|
+
or nature of the software, under any kind of legal claim.***
|
|
109
|
+
|
|
110
|
+
## Definitions
|
|
111
|
+
|
|
112
|
+
The **licensor** is the individual or entity offering these
|
|
113
|
+
terms, and the **software** is the software the licensor makes
|
|
114
|
+
available under these terms.
|
|
115
|
+
|
|
116
|
+
**You** refers to the individual or entity agreeing to these
|
|
117
|
+
terms.
|
|
118
|
+
|
|
119
|
+
**Your company** is any legal entity, sole proprietorship,
|
|
120
|
+
or other kind of organization that you work for, plus all
|
|
121
|
+
organizations that have control over, are under the control of,
|
|
122
|
+
or are under common control with that organization. **Control**
|
|
123
|
+
means ownership of substantially all the assets of an entity,
|
|
124
|
+
or the power to direct its management and policies by vote,
|
|
125
|
+
contract, or otherwise. Control can be direct or indirect.
|
|
126
|
+
|
|
127
|
+
**Your licenses** are all the licenses granted to you for the
|
|
128
|
+
software under these terms.
|
|
129
|
+
|
|
130
|
+
**Use** means anything you do with the software requiring one
|
|
131
|
+
of your licenses.
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
Required Notice: Copyright 2025 Apiasak Pungpapong (https://github.com/apiasak)
|
package/README.md
CHANGED
|
@@ -1,299 +1,225 @@
|
|
|
1
|
-
# AI Sprint
|
|
1
|
+
# AI Sprint Kit
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/ai-sprint-kit)
|
|
4
|
+
[](https://polyformproject.org/licenses/noncommercial/1.0.0/)
|
|
5
|
+
[](https://nodejs.org/)
|
|
4
6
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
- 🤖 **9 Specialized Agents** - Planner, Implementer, Tester, Reviewer, Security, DevOps, Docs, Debugger, Researcher
|
|
8
|
-
- ⚡ **11 Essential Commands** - `/plan`, `/code`, `/test`, `/review`, `/secure`, `/deploy`, `/docs`, `/debug`, `/scan`, `/validate`, `/auto`
|
|
9
|
-
- 🔒 **Security-First** - Built-in SAST, secret detection, dependency scanning
|
|
10
|
-
- 🚀 **Production-Ready** - OWASP Top 10 compliance, security best practices
|
|
11
|
-
- 🎯 **Autonomous** - Full development cycle with human-in-the-loop gates
|
|
12
|
-
- 🧠 **Context Engineering** - Memory system for learning across sessions
|
|
13
|
-
- 📁 **Codebase Scanning** - Auto-scan existing code with 70% token compression
|
|
14
|
-
- 📊 **Custom Statusline** - Real-time context, cost, and session tracking
|
|
15
|
-
|
|
16
|
-
## Installation
|
|
17
|
-
|
|
18
|
-
### Quick Start (Recommended)
|
|
7
|
+
> **Transform Claude Code into an autonomous development powerhouse with one command.**
|
|
19
8
|
|
|
20
9
|
```bash
|
|
21
|
-
npx ai-sprint init
|
|
10
|
+
npx ai-sprint-kit init
|
|
22
11
|
```
|
|
23
12
|
|
|
24
|
-
|
|
13
|
+
---
|
|
25
14
|
|
|
26
|
-
|
|
27
|
-
npm install -g ai-sprint
|
|
28
|
-
ai-sprint init
|
|
29
|
-
```
|
|
15
|
+
## Why AI Sprint Kit?
|
|
30
16
|
|
|
31
|
-
|
|
17
|
+
Most developers use Claude Code for simple Q&A. **AI Sprint Kit** unlocks its full potential:
|
|
32
18
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
19
|
+
| Without AI Sprint | With AI Sprint Kit |
|
|
20
|
+
|-------------------|-------------------|
|
|
21
|
+
| Manual prompting | Autonomous workflows |
|
|
22
|
+
| No memory between sessions | Persistent learning & decisions |
|
|
23
|
+
| Generic responses | Security-first, production-ready code |
|
|
24
|
+
| Single-task focus | Full development cycle automation |
|
|
25
|
+
|
|
26
|
+
---
|
|
36
27
|
|
|
37
|
-
|
|
38
|
-
npx ai-sprint init --force
|
|
28
|
+
## Quick Start
|
|
39
29
|
|
|
40
|
-
|
|
41
|
-
|
|
30
|
+
```bash
|
|
31
|
+
# Install in any project
|
|
32
|
+
npx ai-sprint-kit init
|
|
42
33
|
|
|
43
|
-
#
|
|
44
|
-
|
|
34
|
+
# Start Claude Code
|
|
35
|
+
claude
|
|
45
36
|
|
|
46
|
-
#
|
|
47
|
-
|
|
37
|
+
# Run your first autonomous cycle
|
|
38
|
+
/auto "build a REST API for user management"
|
|
48
39
|
```
|
|
49
40
|
|
|
50
|
-
|
|
41
|
+
**That's it.** The framework handles planning, coding, testing, security scanning, and documentation.
|
|
51
42
|
|
|
52
|
-
|
|
53
|
-
your-project/
|
|
54
|
-
├── .claude/
|
|
55
|
-
│ ├── agents/ # 9 specialized agents
|
|
56
|
-
│ ├── commands/ # 11 slash commands
|
|
57
|
-
│ ├── skills/ # Security scanning scripts
|
|
58
|
-
│ ├── workflows/ # Development rules
|
|
59
|
-
│ ├── settings.json # Configuration
|
|
60
|
-
│ ├── statusline.sh # Terminal statusline script
|
|
61
|
-
│ └── .env.example # Environment template
|
|
62
|
-
├── ai_context/ # AI context & artifacts
|
|
63
|
-
│ ├── plans/ # Implementation plans
|
|
64
|
-
│ ├── docs/ # AI-generated docs
|
|
65
|
-
│ ├── reports/ # Agent outputs
|
|
66
|
-
│ ├── codebase/ # Scanned codebase context (if --scan)
|
|
67
|
-
│ └── memory/ # Learning & decisions
|
|
68
|
-
├── CLAUDE.md # Framework instructions
|
|
69
|
-
└── README.md # User guide
|
|
70
|
-
```
|
|
43
|
+
---
|
|
71
44
|
|
|
72
|
-
##
|
|
45
|
+
## What You Get
|
|
73
46
|
|
|
74
|
-
|
|
75
|
-
# Start Claude Code
|
|
76
|
-
claude
|
|
47
|
+
### 9 Specialized Agents
|
|
77
48
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
49
|
+
| Agent | Superpower |
|
|
50
|
+
|-------|------------|
|
|
51
|
+
| **Planner** | Researches & architects solutions before coding |
|
|
52
|
+
| **Implementer** | Generates production-grade, secure code |
|
|
53
|
+
| **Tester** | Creates comprehensive test suites with 80%+ coverage |
|
|
54
|
+
| **Reviewer** | Enforces code quality & best practices |
|
|
55
|
+
| **Security** | SAST, secret detection, OWASP Top 10 compliance |
|
|
56
|
+
| **DevOps** | Sets up CI/CD pipelines & deployments |
|
|
57
|
+
| **Docs** | Generates & maintains documentation |
|
|
58
|
+
| **Debugger** | Root cause analysis with fix recommendations |
|
|
59
|
+
| **Researcher** | Web search for latest libraries & best practices |
|
|
85
60
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
| Agent | Purpose |
|
|
89
|
-
|-------|---------|
|
|
90
|
-
| **planner** | Research & create implementation plans |
|
|
91
|
-
| **implementer** | Generate production-grade code |
|
|
92
|
-
| **tester** | Create and run automated tests |
|
|
93
|
-
| **reviewer** | Code quality and best practices review |
|
|
94
|
-
| **security** | SAST, secret detection, dependency scanning |
|
|
95
|
-
| **devops** | CI/CD setup and deployment |
|
|
96
|
-
| **docs** | Generate documentation |
|
|
97
|
-
| **debugger** | Root cause analysis and fixes |
|
|
98
|
-
| **researcher** | Technology research with web search |
|
|
99
|
-
|
|
100
|
-
## Commands
|
|
101
|
-
|
|
102
|
-
| Command | Description | Example |
|
|
103
|
-
|---------|-------------|---------|
|
|
104
|
-
| `/plan` | Create implementation plan | `/plan "add payment processing"` |
|
|
105
|
-
| `/code` | Generate/refactor code | `/code "implement OAuth2 login"` |
|
|
106
|
-
| `/test` | Generate and run tests | `/test` |
|
|
107
|
-
| `/review` | Code quality review | `/review src/` |
|
|
108
|
-
| `/secure` | Security scan | `/secure` |
|
|
109
|
-
| `/deploy` | CI/CD setup | `/deploy --platform github` |
|
|
110
|
-
| `/docs` | Generate documentation | `/docs` |
|
|
111
|
-
| `/debug` | Investigate issues | `/debug "500 error on login"` |
|
|
112
|
-
| `/scan` | Scan codebase for AI context | `/scan` |
|
|
113
|
-
| `/validate` | Pre-commit validation | `/validate` |
|
|
114
|
-
| `/auto` | Automatic full cycle | `/auto "build user dashboard"` |
|
|
115
|
-
|
|
116
|
-
## Security Features
|
|
117
|
-
|
|
118
|
-
### Built-in Scans
|
|
119
|
-
- ✅ **SAST** - Static application security testing
|
|
120
|
-
- ✅ **Secret Detection** - Find hardcoded credentials
|
|
121
|
-
- ✅ **Dependency Check** - Vulnerable packages
|
|
122
|
-
- ✅ **OWASP Top 10** - Compliance validation
|
|
123
|
-
|
|
124
|
-
### Security Tools (Optional)
|
|
125
|
-
```bash
|
|
126
|
-
# Install security scanning tools
|
|
127
|
-
pip install snyk semgrep detect-secrets safety
|
|
128
|
-
```
|
|
61
|
+
### 11 Slash Commands
|
|
129
62
|
|
|
130
|
-
### Configuration
|
|
131
|
-
Set API tokens in `.env`:
|
|
132
63
|
```bash
|
|
133
|
-
|
|
134
|
-
|
|
64
|
+
/plan # Create implementation plans
|
|
65
|
+
/code # Generate or refactor code
|
|
66
|
+
/test # Generate and run tests
|
|
67
|
+
/review # Code quality review
|
|
68
|
+
/secure # Security scanning
|
|
69
|
+
/deploy # CI/CD setup
|
|
70
|
+
/docs # Generate documentation
|
|
71
|
+
/debug # Investigate issues
|
|
72
|
+
/scan # Index codebase for AI context
|
|
73
|
+
/validate # Pre-commit checks
|
|
74
|
+
/auto # Full autonomous cycle
|
|
135
75
|
```
|
|
136
76
|
|
|
137
|
-
|
|
77
|
+
### Built-in Security
|
|
138
78
|
|
|
139
|
-
|
|
140
|
-
|
|
79
|
+
- **SAST** - Static application security testing
|
|
80
|
+
- **Secret Detection** - Find hardcoded credentials
|
|
81
|
+
- **Dependency Scanning** - Vulnerable packages
|
|
82
|
+
- **OWASP Top 10** - Compliance validation
|
|
141
83
|
|
|
142
|
-
|
|
143
|
-
# Current directory
|
|
144
|
-
ai-sprint init
|
|
145
|
-
|
|
146
|
-
# Specific directory
|
|
147
|
-
ai-sprint init --dir /path/to/project
|
|
148
|
-
|
|
149
|
-
# Force overwrite
|
|
150
|
-
ai-sprint init --force
|
|
84
|
+
### Context Engineering
|
|
151
85
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
86
|
+
- **Memory System** - Learns from past sessions
|
|
87
|
+
- **Decision Tracking** - Records architectural choices
|
|
88
|
+
- **Codebase Indexing** - 70% token compression with Repomix
|
|
155
89
|
|
|
156
|
-
###
|
|
157
|
-
Scan codebase and generate AI context documents
|
|
90
|
+
### Real-time Statusline
|
|
158
91
|
|
|
159
|
-
|
|
160
|
-
# Current directory
|
|
161
|
-
ai-sprint scan
|
|
92
|
+
Track context usage, costs, and session progress directly in your terminal.
|
|
162
93
|
|
|
163
|
-
|
|
164
|
-
ai-sprint scan --dir /path/to/project
|
|
165
|
-
```
|
|
94
|
+
---
|
|
166
95
|
|
|
167
|
-
|
|
96
|
+
## Installation
|
|
168
97
|
|
|
169
|
-
###
|
|
170
|
-
Show available agents and commands
|
|
98
|
+
### Option 1: npx (Recommended)
|
|
171
99
|
|
|
172
100
|
```bash
|
|
173
|
-
ai-sprint
|
|
101
|
+
npx ai-sprint-kit init
|
|
174
102
|
```
|
|
175
103
|
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
### Local Testing
|
|
104
|
+
### Option 2: Global Install
|
|
179
105
|
|
|
180
106
|
```bash
|
|
181
|
-
|
|
182
|
-
git clone https://github.com/yourusername/ai-sprint
|
|
183
|
-
cd ai-sprint
|
|
184
|
-
|
|
185
|
-
# Install dependencies
|
|
186
|
-
npm install
|
|
187
|
-
|
|
188
|
-
# Link locally
|
|
189
|
-
npm link
|
|
190
|
-
|
|
191
|
-
# Test installation
|
|
192
|
-
mkdir test-project
|
|
193
|
-
cd test-project
|
|
107
|
+
npm install -g ai-sprint-kit
|
|
194
108
|
ai-sprint init
|
|
109
|
+
```
|
|
195
110
|
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
111
|
+
### Options
|
|
112
|
+
|
|
113
|
+
```bash
|
|
114
|
+
--dir <path> # Install in specific directory
|
|
115
|
+
--force # Overwrite existing installation
|
|
116
|
+
--skip-install # Skip Python dependencies
|
|
117
|
+
--scan # Force codebase scanning
|
|
118
|
+
--no-scan # Skip codebase scanning
|
|
199
119
|
```
|
|
200
120
|
|
|
201
|
-
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## Project Structure After Installation
|
|
202
124
|
|
|
203
125
|
```
|
|
204
|
-
|
|
205
|
-
├──
|
|
206
|
-
│
|
|
207
|
-
├──
|
|
208
|
-
│ ├──
|
|
209
|
-
│
|
|
210
|
-
├──
|
|
211
|
-
│
|
|
212
|
-
|
|
213
|
-
│
|
|
214
|
-
├──
|
|
215
|
-
|
|
126
|
+
your-project/
|
|
127
|
+
├── .claude/
|
|
128
|
+
│ ├── agents/ # 9 specialized agents
|
|
129
|
+
│ ├── commands/ # 11 slash commands
|
|
130
|
+
│ ├── skills/ # Modular capabilities
|
|
131
|
+
│ ├── workflows/ # Development rules
|
|
132
|
+
│ ├── settings.json # Configuration
|
|
133
|
+
│ └── statusline.sh # Terminal statusline
|
|
134
|
+
├── ai_context/
|
|
135
|
+
│ ├── plans/ # Implementation plans
|
|
136
|
+
│ ├── reports/ # Agent outputs
|
|
137
|
+
│ ├── codebase/ # Indexed source code
|
|
138
|
+
│ └── memory/ # Learning & decisions
|
|
139
|
+
├── CLAUDE.md # Framework instructions
|
|
140
|
+
└── README.md # User guide
|
|
216
141
|
```
|
|
217
142
|
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
- Node.js >= 18.0.0
|
|
221
|
-
- Claude Code CLI
|
|
222
|
-
- Python 3.8+ (optional, for security skills)
|
|
143
|
+
---
|
|
223
144
|
|
|
224
145
|
## Examples
|
|
225
146
|
|
|
226
|
-
###
|
|
147
|
+
### New Project
|
|
148
|
+
|
|
227
149
|
```bash
|
|
228
|
-
mkdir my-
|
|
229
|
-
|
|
230
|
-
npx ai-sprint init
|
|
150
|
+
mkdir my-app && cd my-app
|
|
151
|
+
npx ai-sprint-kit init
|
|
231
152
|
claude
|
|
232
|
-
/auto "build
|
|
153
|
+
/auto "build e-commerce API with Stripe integration"
|
|
233
154
|
```
|
|
234
155
|
|
|
235
|
-
###
|
|
156
|
+
### Existing Project
|
|
157
|
+
|
|
236
158
|
```bash
|
|
237
|
-
cd existing-project
|
|
238
|
-
npx ai-sprint init
|
|
159
|
+
cd my-existing-project
|
|
160
|
+
npx ai-sprint-kit init --scan
|
|
239
161
|
claude
|
|
240
|
-
/
|
|
241
|
-
/
|
|
162
|
+
/review # Analyze code quality
|
|
163
|
+
/secure # Find vulnerabilities
|
|
242
164
|
```
|
|
243
165
|
|
|
244
|
-
###
|
|
166
|
+
### Security-First Development
|
|
167
|
+
|
|
245
168
|
```bash
|
|
246
|
-
npx ai-sprint init
|
|
247
|
-
claude
|
|
248
169
|
/plan "implement payment processing"
|
|
249
|
-
/code "
|
|
250
|
-
/secure
|
|
251
|
-
/
|
|
170
|
+
/code "build with PCI DSS compliance"
|
|
171
|
+
/secure # Comprehensive scan
|
|
172
|
+
/validate # Pre-commit checks
|
|
252
173
|
```
|
|
253
174
|
|
|
254
|
-
|
|
175
|
+
---
|
|
255
176
|
|
|
256
|
-
|
|
257
|
-
```bash
|
|
258
|
-
# Use npx instead
|
|
259
|
-
npx ai-sprint init
|
|
177
|
+
## Requirements
|
|
260
178
|
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
179
|
+
- **Node.js** >= 18.0.0
|
|
180
|
+
- **Claude Code** CLI installed
|
|
181
|
+
- **Python 3.8+** (optional, for advanced security skills)
|
|
264
182
|
|
|
265
|
-
|
|
266
|
-
```bash
|
|
267
|
-
# Use --force to overwrite
|
|
268
|
-
npx ai-sprint init --force
|
|
269
|
-
```
|
|
183
|
+
---
|
|
270
184
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
185
|
+
## CLI Reference
|
|
186
|
+
|
|
187
|
+
| Command | Description |
|
|
188
|
+
|---------|-------------|
|
|
189
|
+
| `ai-sprint init` | Install framework |
|
|
190
|
+
| `ai-sprint scan` | Index codebase |
|
|
191
|
+
| `ai-sprint list` | Show agents & commands |
|
|
192
|
+
|
|
193
|
+
---
|
|
279
194
|
|
|
280
195
|
## Contributing
|
|
281
196
|
|
|
282
|
-
Contributions welcome!
|
|
197
|
+
Contributions welcome!
|
|
198
|
+
|
|
283
199
|
1. Fork the repository
|
|
284
200
|
2. Create a feature branch
|
|
285
201
|
3. Make your changes
|
|
286
202
|
4. Submit a pull request
|
|
287
203
|
|
|
288
|
-
|
|
204
|
+
---
|
|
289
205
|
|
|
290
|
-
|
|
206
|
+
## Links
|
|
207
|
+
|
|
208
|
+
- [npm Package](https://www.npmjs.com/package/ai-sprint-kit)
|
|
209
|
+
- [GitHub Repository](https://github.com/apiasak/ai-sprint-kit)
|
|
210
|
+
- [Issues](https://github.com/apiasak/ai-sprint-kit/issues)
|
|
211
|
+
- [Framework Documentation](./templates/README.md)
|
|
212
|
+
|
|
213
|
+
---
|
|
214
|
+
|
|
215
|
+
## License
|
|
291
216
|
|
|
292
|
-
|
|
217
|
+
**PolyForm Noncommercial 1.0.0** - Free for personal and non-commercial use. See [LICENSE](./LICENSE) file.
|
|
293
218
|
|
|
294
|
-
|
|
295
|
-
- Documentation: [Framework README](./templates/README.md)
|
|
219
|
+
**Not permitted:** Commercial use, resale, or incorporation into commercial products.
|
|
296
220
|
|
|
297
221
|
---
|
|
298
222
|
|
|
299
|
-
|
|
223
|
+
<p align="center">
|
|
224
|
+
<strong>Built for developers who want to ship faster, safer, and smarter.</strong>
|
|
225
|
+
</p>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ai-sprint-kit",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.5",
|
|
4
4
|
"description": "CLI installer for autonomous coding agent framework - security-first, production-grade Claude Code setup",
|
|
5
5
|
"main": "lib/installer.js",
|
|
6
6
|
"bin": {
|
|
@@ -21,16 +21,16 @@
|
|
|
21
21
|
"code-generation",
|
|
22
22
|
"ai-sprint"
|
|
23
23
|
],
|
|
24
|
-
"author": "
|
|
25
|
-
"license": "
|
|
24
|
+
"author": "Apiasak Pungpapong",
|
|
25
|
+
"license": "PolyForm-Noncommercial-1.0.0",
|
|
26
26
|
"repository": {
|
|
27
27
|
"type": "git",
|
|
28
|
-
"url": "https://github.com/
|
|
28
|
+
"url": "https://github.com/apiasak/ai-sprint-kit.git"
|
|
29
29
|
},
|
|
30
30
|
"bugs": {
|
|
31
|
-
"url": "https://github.com/
|
|
31
|
+
"url": "https://github.com/apiasak/ai-sprint-kit/issues"
|
|
32
32
|
},
|
|
33
|
-
"homepage": "https://github.com/
|
|
33
|
+
"homepage": "https://github.com/apiasak/ai-sprint-kit#readme",
|
|
34
34
|
"files": [
|
|
35
35
|
"bin/",
|
|
36
36
|
"lib/",
|
|
@@ -56,11 +56,11 @@ ls -la ai_context/codebase/ 2>/dev/null || echo "No existing scan found"
|
|
|
56
56
|
|
|
57
57
|
### Step 2: Run Codebase Scan
|
|
58
58
|
|
|
59
|
-
Use the `ai-sprint scan` CLI command or run repomix directly:
|
|
59
|
+
Use the `ai-sprint-kit scan` CLI command or run repomix directly:
|
|
60
60
|
|
|
61
61
|
```bash
|
|
62
62
|
# Option A: Use AI Sprint CLI (if available)
|
|
63
|
-
ai-sprint scan
|
|
63
|
+
ai-sprint-kit scan
|
|
64
64
|
|
|
65
65
|
# Option B: Run repomix directly
|
|
66
66
|
npx repomix --compress --style xml -o ai_context/codebase/repomix-output.xml
|
package/templates/README.md
CHANGED
|
@@ -115,7 +115,7 @@ Skills are activated automatically when relevant.
|
|
|
115
115
|
AI Sprint can scan existing codebases to help agents understand the project quickly.
|
|
116
116
|
|
|
117
117
|
### Automatic Scanning
|
|
118
|
-
When you run `ai-sprint init` on a project with existing source code, it automatically scans and generates context documents.
|
|
118
|
+
When you run `ai-sprint-kit init` on a project with existing source code, it automatically scans and generates context documents.
|
|
119
119
|
|
|
120
120
|
### Manual Scanning
|
|
121
121
|
```bash
|
|
@@ -123,7 +123,7 @@ When you run `ai-sprint init` on a project with existing source code, it automat
|
|
|
123
123
|
/scan
|
|
124
124
|
|
|
125
125
|
# Or use CLI directly
|
|
126
|
-
ai-sprint scan
|
|
126
|
+
ai-sprint-kit scan
|
|
127
127
|
```
|
|
128
128
|
|
|
129
129
|
### Output
|
|
@@ -144,7 +144,7 @@ This runs: tests + code review + security scan. Blocks if:
|
|
|
144
144
|
|
|
145
145
|
```bash
|
|
146
146
|
# Install framework
|
|
147
|
-
npx ai-sprint init
|
|
147
|
+
npx ai-sprint-kit init
|
|
148
148
|
|
|
149
149
|
# Scan existing code for issues
|
|
150
150
|
/secure
|
|
@@ -570,7 +570,7 @@ ls .claude/commands/
|
|
|
570
570
|
If missing, reinstall:
|
|
571
571
|
|
|
572
572
|
```bash
|
|
573
|
-
npx ai-sprint init --force
|
|
573
|
+
npx ai-sprint-kit init --force
|
|
574
574
|
```
|
|
575
575
|
|
|
576
576
|
---
|