ai-sprint-kit 1.1.1 → 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.
Files changed (3) hide show
  1. package/LICENSE +135 -0
  2. package/README.md +143 -219
  3. package/package.json +3 -3
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,301 +1,225 @@
1
1
  # AI Sprint Kit
2
2
 
3
- **One-command installer for Claude Code autonomous development framework**
3
+ [![npm version](https://img.shields.io/npm/v/ai-sprint-kit.svg)](https://www.npmjs.com/package/ai-sprint-kit)
4
+ [![License: PolyForm Noncommercial](https://img.shields.io/badge/License-PolyForm%20Noncommercial-blue.svg)](https://polyformproject.org/licenses/noncommercial/1.0.0/)
5
+ [![Node.js](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org/)
4
6
 
5
- > **Package name:** `ai-sprint-kit` | **CLI command:** `ai-sprint`
6
-
7
- ## Features
8
-
9
- - 🤖 **9 Specialized Agents** - Planner, Implementer, Tester, Reviewer, Security, DevOps, Docs, Debugger, Researcher
10
- - ⚡ **11 Essential Commands** - `/plan`, `/code`, `/test`, `/review`, `/secure`, `/deploy`, `/docs`, `/debug`, `/scan`, `/validate`, `/auto`
11
- - 🔒 **Security-First** - Built-in SAST, secret detection, dependency scanning
12
- - 🚀 **Production-Ready** - OWASP Top 10 compliance, security best practices
13
- - 🎯 **Autonomous** - Full development cycle with human-in-the-loop gates
14
- - 🧠 **Context Engineering** - Memory system for learning across sessions
15
- - 📁 **Codebase Scanning** - Auto-scan existing code with 70% token compression
16
- - 📊 **Custom Statusline** - Real-time context, cost, and session tracking
17
-
18
- ## Installation
19
-
20
- ### Quick Start (Recommended)
7
+ > **Transform Claude Code into an autonomous development powerhouse with one command.**
21
8
 
22
9
  ```bash
23
10
  npx ai-sprint-kit init
24
11
  ```
25
12
 
26
- ### Global Installation
13
+ ---
27
14
 
28
- ```bash
29
- npm install -g ai-sprint-kit
30
- ai-sprint init
31
- ```
15
+ ## Why AI Sprint Kit?
32
16
 
33
- ### Options
17
+ Most developers use Claude Code for simple Q&A. **AI Sprint Kit** unlocks its full potential:
34
18
 
35
- ```bash
36
- # Install in specific directory
37
- npx ai-sprint-kit init --dir /path/to/project
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
+ ---
38
27
 
39
- # Force overwrite existing .claude/
40
- npx ai-sprint-kit init --force
28
+ ## Quick Start
41
29
 
42
- # Skip Python dependencies
43
- npx ai-sprint-kit init --skip-install
30
+ ```bash
31
+ # Install in any project
32
+ npx ai-sprint-kit init
44
33
 
45
- # Scan existing codebase (auto-detected if source exists)
46
- npx ai-sprint-kit init --scan
34
+ # Start Claude Code
35
+ claude
47
36
 
48
- # Skip codebase scanning
49
- npx ai-sprint-kit init --no-scan
37
+ # Run your first autonomous cycle
38
+ /auto "build a REST API for user management"
50
39
  ```
51
40
 
52
- ## What Gets Installed
41
+ **That's it.** The framework handles planning, coding, testing, security scanning, and documentation.
53
42
 
54
- ```
55
- your-project/
56
- ├── .claude/
57
- │ ├── agents/ # 9 specialized agents
58
- │ ├── commands/ # 11 slash commands
59
- │ ├── skills/ # Security scanning scripts
60
- │ ├── workflows/ # Development rules
61
- │ ├── settings.json # Configuration
62
- │ ├── statusline.sh # Terminal statusline script
63
- │ └── .env.example # Environment template
64
- ├── ai_context/ # AI context & artifacts
65
- │ ├── plans/ # Implementation plans
66
- │ ├── docs/ # AI-generated docs
67
- │ ├── reports/ # Agent outputs
68
- │ ├── codebase/ # Scanned codebase context (if --scan)
69
- │ └── memory/ # Learning & decisions
70
- ├── CLAUDE.md # Framework instructions
71
- └── README.md # User guide
72
- ```
43
+ ---
73
44
 
74
- ## Usage After Installation
45
+ ## What You Get
75
46
 
76
- ```bash
77
- # Start Claude Code
78
- claude
47
+ ### 9 Specialized Agents
79
48
 
80
- # Use commands
81
- /plan "implement user authentication"
82
- /code "build the authentication system"
83
- /test "generate and run tests"
84
- /secure "run security scans"
85
- /auto "full autonomous cycle"
86
- ```
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 |
87
60
 
88
- ## Agents
89
-
90
- | Agent | Purpose |
91
- |-------|---------|
92
- | **planner** | Research & create implementation plans |
93
- | **implementer** | Generate production-grade code |
94
- | **tester** | Create and run automated tests |
95
- | **reviewer** | Code quality and best practices review |
96
- | **security** | SAST, secret detection, dependency scanning |
97
- | **devops** | CI/CD setup and deployment |
98
- | **docs** | Generate documentation |
99
- | **debugger** | Root cause analysis and fixes |
100
- | **researcher** | Technology research with web search |
101
-
102
- ## Commands
103
-
104
- | Command | Description | Example |
105
- |---------|-------------|---------|
106
- | `/plan` | Create implementation plan | `/plan "add payment processing"` |
107
- | `/code` | Generate/refactor code | `/code "implement OAuth2 login"` |
108
- | `/test` | Generate and run tests | `/test` |
109
- | `/review` | Code quality review | `/review src/` |
110
- | `/secure` | Security scan | `/secure` |
111
- | `/deploy` | CI/CD setup | `/deploy --platform github` |
112
- | `/docs` | Generate documentation | `/docs` |
113
- | `/debug` | Investigate issues | `/debug "500 error on login"` |
114
- | `/scan` | Scan codebase for AI context | `/scan` |
115
- | `/validate` | Pre-commit validation | `/validate` |
116
- | `/auto` | Automatic full cycle | `/auto "build user dashboard"` |
117
-
118
- ## Security Features
119
-
120
- ### Built-in Scans
121
- - ✅ **SAST** - Static application security testing
122
- - ✅ **Secret Detection** - Find hardcoded credentials
123
- - ✅ **Dependency Check** - Vulnerable packages
124
- - ✅ **OWASP Top 10** - Compliance validation
125
-
126
- ### Security Tools (Optional)
127
- ```bash
128
- # Install security scanning tools
129
- pip install snyk semgrep detect-secrets safety
130
- ```
61
+ ### 11 Slash Commands
131
62
 
132
- ### Configuration
133
- Set API tokens in `.env`:
134
63
  ```bash
135
- SNYK_TOKEN=your_token
136
- SEMGREP_APP_TOKEN=your_token
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
137
75
  ```
138
76
 
139
- ## CLI Commands
77
+ ### Built-in Security
140
78
 
141
- ### `ai-sprint init`
142
- Install framework in current or specified directory
79
+ - **SAST** - Static application security testing
80
+ - **Secret Detection** - Find hardcoded credentials
81
+ - **Dependency Scanning** - Vulnerable packages
82
+ - **OWASP Top 10** - Compliance validation
143
83
 
144
- ```bash
145
- # Current directory
146
- ai-sprint init
84
+ ### Context Engineering
147
85
 
148
- # Specific directory
149
- ai-sprint init --dir /path/to/project
86
+ - **Memory System** - Learns from past sessions
87
+ - **Decision Tracking** - Records architectural choices
88
+ - **Codebase Indexing** - 70% token compression with Repomix
150
89
 
151
- # Force overwrite
152
- ai-sprint init --force
153
-
154
- # Skip Python dependencies
155
- ai-sprint init --skip-install
156
- ```
90
+ ### Real-time Statusline
157
91
 
158
- ### `ai-sprint scan`
159
- Scan codebase and generate AI context documents
92
+ Track context usage, costs, and session progress directly in your terminal.
160
93
 
161
- ```bash
162
- # Current directory
163
- ai-sprint scan
164
-
165
- # Specific directory
166
- ai-sprint scan --dir /path/to/project
167
- ```
94
+ ---
168
95
 
169
- **Output:** `ai_context/codebase/` with overview.md, structure.md, repomix-output.xml
96
+ ## Installation
170
97
 
171
- ### `ai-sprint list`
172
- Show available agents and commands
98
+ ### Option 1: npx (Recommended)
173
99
 
174
100
  ```bash
175
- ai-sprint list
101
+ npx ai-sprint-kit init
176
102
  ```
177
103
 
178
- ## Development
179
-
180
- ### Local Testing
104
+ ### Option 2: Global Install
181
105
 
182
106
  ```bash
183
- # Clone repository
184
- git clone https://github.com/yourusername/ai-sprint-kit
185
- cd ai-sprint-kit
186
-
187
- # Install dependencies
188
- npm install
189
-
190
- # Link locally
191
- npm link
192
-
193
- # Test installation
194
- mkdir test-project
195
- cd test-project
107
+ npm install -g ai-sprint-kit
196
108
  ai-sprint init
109
+ ```
197
110
 
198
- # Test with Claude Code
199
- claude
200
- /plan "test feature"
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
201
119
  ```
202
120
 
203
- ### Package Structure
121
+ ---
122
+
123
+ ## Project Structure After Installation
204
124
 
205
125
  ```
206
- ai-sprint-kit/
207
- ├── bin/
208
- └── cli.js # CLI entry point
209
- ├── lib/
210
- │ ├── installer.js # Installation logic
211
- └── scanner.js # Codebase scanning logic
212
- ├── templates/
213
- ├── .claude/ # Framework templates
214
- ├── CLAUDE.md # Instructions
215
- └── README.md # User guide
216
- ├── package.json
217
- └── README.md # This file
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
218
141
  ```
219
142
 
220
- ## Requirements
221
-
222
- - Node.js >= 18.0.0
223
- - Claude Code CLI
224
- - Python 3.8+ (optional, for security skills)
143
+ ---
225
144
 
226
145
  ## Examples
227
146
 
228
- ### Example 1: New Project Setup
147
+ ### New Project
148
+
229
149
  ```bash
230
- mkdir my-project
231
- cd my-project
150
+ mkdir my-app && cd my-app
232
151
  npx ai-sprint-kit init
233
152
  claude
234
- /auto "build REST API for todo app"
153
+ /auto "build e-commerce API with Stripe integration"
235
154
  ```
236
155
 
237
- ### Example 2: Add to Existing Project
156
+ ### Existing Project
157
+
238
158
  ```bash
239
- cd existing-project
240
- npx ai-sprint-kit init
159
+ cd my-existing-project
160
+ npx ai-sprint-kit init --scan
241
161
  claude
242
- /secure # Scan existing code
243
- /review # Review code quality
162
+ /review # Analyze code quality
163
+ /secure # Find vulnerabilities
244
164
  ```
245
165
 
246
- ### Example 3: Security-Focused Development
166
+ ### Security-First Development
167
+
247
168
  ```bash
248
- npx ai-sprint-kit init
249
- claude
250
169
  /plan "implement payment processing"
251
- /code "implement with PCI DSS compliance"
252
- /secure # Comprehensive security scan
253
- /review # Security-focused review
170
+ /code "build with PCI DSS compliance"
171
+ /secure # Comprehensive scan
172
+ /validate # Pre-commit checks
254
173
  ```
255
174
 
256
- ## Troubleshooting
175
+ ---
257
176
 
258
- ### "Command not found: ai-sprint"
259
- ```bash
260
- # Use npx instead
261
- npx ai-sprint-kit init
177
+ ## Requirements
262
178
 
263
- # Or install globally
264
- npm install -g ai-sprint-kit
265
- ```
179
+ - **Node.js** >= 18.0.0
180
+ - **Claude Code** CLI installed
181
+ - **Python 3.8+** (optional, for advanced security skills)
266
182
 
267
- ### ".claude/ already exists"
268
- ```bash
269
- # Use --force to overwrite
270
- npx ai-sprint-kit init --force
271
- ```
183
+ ---
272
184
 
273
- ### "Python dependencies failed"
274
- ```bash
275
- # Install manually
276
- cd .claude/skills
277
- python3 -m venv .venv
278
- source .venv/bin/activate # or .venv\Scripts\activate on Windows
279
- pip install -r requirements.txt
280
- ```
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
+ ---
281
194
 
282
195
  ## Contributing
283
196
 
284
- Contributions welcome! Please:
197
+ Contributions welcome!
198
+
285
199
  1. Fork the repository
286
200
  2. Create a feature branch
287
201
  3. Make your changes
288
202
  4. Submit a pull request
289
203
 
290
- ## License
204
+ ---
205
+
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)
291
212
 
292
- MIT License - see LICENSE file
213
+ ---
214
+
215
+ ## License
293
216
 
294
- ## Support
217
+ **PolyForm Noncommercial 1.0.0** - Free for personal and non-commercial use. See [LICENSE](./LICENSE) file.
295
218
 
296
- - Issues: [GitHub Issues](https://github.com/yourusername/ai-sprint-kit/issues)
297
- - Documentation: [Framework README](./templates/README.md)
219
+ **Not permitted:** Commercial use, resale, or incorporation into commercial products.
298
220
 
299
221
  ---
300
222
 
301
- **Made with ❤️ for autonomous developers**
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.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,8 +21,8 @@
21
21
  "code-generation",
22
22
  "ai-sprint"
23
23
  ],
24
- "author": "Your Name",
25
- "license": "MIT",
24
+ "author": "Apiasak Pungpapong",
25
+ "license": "PolyForm-Noncommercial-1.0.0",
26
26
  "repository": {
27
27
  "type": "git",
28
28
  "url": "https://github.com/apiasak/ai-sprint-kit.git"