gigaspec 4.0.0

package/GETTING_STARTED.md

@@ -0,0 +1,153 @@
+# Getting Started with Gigaspec
+
+Welcome! This guide walks you through using Gigaspec to build your project with AI collaboration.
+
+---
+
+## 📖 What You Have Now
+
+After running `gigaspec init`, you have:
+
+```
+Gigaspec/
+├── AGENT.md          ← The "rulebook" for AI assistants
+├── STATE.md          ← Your project's current status & todo list
+├── SETUP.md          ← How to set up your development environment
+├── PLAN.md           ← Development roadmap (phases, milestones)
+├── ARCHITECTURE.md   ← System design & tech decisions
+├── WORKFLOW.md       ← How to work with AI assistants
+├── DEPLOYMENT.md     ← How to deploy to production
+├── ENVIRONMENT.md    ← Environment variables & secrets
+└── GETTING_STARTED.md ← This file!
+```
+
+---
+
+## 🚀 Your First Steps (Do This Now)
+
+### Step 1: Check Your Status
+
+```bash
+gigaspec status
+```
+
+This shows what is next. **Always start here!**
+
+### Step 2: Read STATE.md
+
+Open `STATE.md` and look at **## 📋 Next Priority**.  
+This tells you exactly what to work on first.
+
+### Step 3: Do the First Task
+
+Example: If it says "Set up local development environment":
+
+1. Open `SETUP.md`
+2. Follow the instructions for Node.js/Express
+3. Run the verification commands
+
+### Step 4: Update Your Progress ⭐ IMPORTANT
+
+After completing a task, **edit STATE.md**:
+
+- Move completed items to `## ✅ Completed`
+- Update `## 📋 Next Priority`
+- This keeps everyone (you + AI) in sync!
+
+### Step 5: Continue the Loop
+
+1. Check `gigaspec status`
+2. Do the next task
+3. Update `STATE.md`
+4. Repeat!
+
+---
+
+## 🤖 Working with AI Assistants
+
+### Before AI Starts Coding
+
+Always tell the AI:
+
+> "Please read AGENT.md and STATE.md before we start"
+
+This gives the AI:
+- Coding standards (from AGENT.md)
+- Current context (from STATE.md)
+- What's next (from Next Priority)
+
+### Quick AI Commands
+
+| You Say | AI Does |
+|---------|---------|
+| "What should I work on?" | Reads STATE.md → Tells you next task |
+| "Let's implement [feature]" | Reads PLAN.md → Creates plan → Implements |
+| "Review this code" | Checks AGENT.md → Reviews against standards |
+| "I'm done" | Updates STATE.md → Suggests next step |
+
+---
+
+## 📚 Document Quick Reference
+
+| Document | When to Read |
+|----------|--------------|
+| **STATE.md** | ✅ At start of every session |
+| **AGENT.md** | ✅ Before writing any code |
+| **SETUP.md** | Setting up dev environment |
+| **PLAN.md** | Planning new features |
+| **WORKFLOW.md** | Understanding AI collaboration |
+
+---
+
+## ✅ Daily Checklist
+
+- [ ] Run `gigaspec status`
+- [ ] Read STATE.md
+- [ ] Complete one task
+- [ ] Update STATE.md
+- [ ] Tell AI to follow AGENT.md
+
+---
+
+## 🆘 Common Questions
+
+### "What should I work on right now?"
+
+```bash
+gigaspec status
+```
+
+Look at **Next Priority** section in STATE.md.
+
+### "How do I set up my dev environment?"
+
+Read `SETUP.md` — it has step-by-step instructions for Node.js/Express.
+
+### "The AI isn't following my stack's patterns"
+
+Tell the AI: **"Please read AGENT.md and follow the stack-specific patterns"**
+
+### "How do I track progress?"
+
+Keep `STATE.md` updated! Both you and AI should read it before each session.
+
+---
+
+## 🎯 Success Check
+
+You're using Gigaspec correctly when:
+
+- ✅ You run `gigaspec status` at the start of each session
+- ✅ STATE.md accurately shows what's done and what's next
+- ✅ AI assistants reference AGENT.md when coding
+- ✅ New AI assistants can onboard by reading the docs
+
+---
+
+## 📖 Next Step
+
+**Right now:** Run `gigaspec status` and do the first item in "Next Priority"!
+
+---
+
+**Remember:** The docs only work if you keep them updated! 🚀

package/IMPLEMENTATION_SUMMARY.md

@@ -0,0 +1,261 @@
+# Gigaspec Implementation Summary
+
+## Overview
+Gigaspec is a fully AI-native specification framework for spec-driven development. It enables AI assistants (Kimi, Claude, etc.) to guide humans through project initialization, stack selection, and development.
+
+---
+
+## Files Structure
+
+```
+gigaspec/
+├── bin/
+│   ├── gigaspec.js       # Main CLI with AI-native commands
+│   └── mcp-server.js     # MCP server for AI IDE integration
+├── lib/
+│   ├── framework.js      # Core framework (GigaspecFramework)
+│   ├── ai-workflow.js    # AI workflow engine (AIWorkflowEngine)
+│   ├── templates.js      # Document templates
+│   └── index.js          # Public API exports
+├── test/
+│   └── gigaspec.test.js  # Test suite (13 tests)
+├── package.json          # Package configuration
+└── README.md             # Documentation
+```
+
+---
+
+## Core Features Implemented
+
+### 1. AI-Native Workflow (`gigaspec init --json`)
+
+**New Project Flow:**
+```bash
+gigaspec init --json                 # Returns menu
+# AI presents: "New or existing?"
+
+gigaspec init --type new --json      # Starts interview
+# Returns first question
+
+gigaspec interview -q <id> -a <answer> --json  # Process answer
+# Returns next question or recommendations
+```
+
+**Existing Project Flow:**
+```bash
+gigaspec init --type existing --path . --json
+# Returns codebase analysis + gaps + interview questions
+```
+
+### 2. AI Interview System
+
+8-question interview that gathers:
+- Project purpose
+- User types and scale
+- Key features
+- Real-time requirements
+- Authentication needs
+- Payment requirements
+- Expected scale
+- Team expertise
+
+**Output:** Stack recommendations with reasoning
+
+### 3. Automated Development Commands
+
+```bash
+gigaspec continue --json    # Returns current task + context
+gigaspec verify --json      # Verifies code against AGENT.md
+gigaspec status --json      # Returns project status
+```
+
+### 4. MCP Server Integration
+
+```bash
+gigaspec-mcp  # Runs MCP server for AI IDE integration
+```
+
+Available tools:
+- `gigaspec-init`
+- `gigaspec-analyze`
+- `gigaspec-generate`
+- `gigaspec-status`
+- `gigaspec-wizard`
+
+### 5. Generated Documents
+
+- `AGENT.md` - AI coding standards & constraints
+- `STATE.md` - Project status & next tasks
+- `PLAN.md` - Development roadmap
+- `ARCHITECTURE.md` - System design
+- `SETUP.md` - Environment setup guide
+- `DEPLOYMENT.md` - Production deployment
+- `ENVIRONMENT.md` - Secrets management
+- `GETTING_STARTED.md` - Step-by-step user guide
+
+---
+
+## Test Coverage
+
+13 tests covering:
+- `GigaspecFramework.createAnalysisPrompt()`
+- `GigaspecFramework.createRefinementPrompt()`
+- `GigaspecFramework.parseAnalysis()`
+- `GigaspecFramework.generate()` (file generation + infrastructure)
+- `analyzeCommand()` (JSON output)
+- `generateCommand()` (config file + error handling)
+- `AIWorkflowEngine.startNewProject()`
+- `AIWorkflowEngine.processInterviewAnswer()` (partial + complete)
+- `AIWorkflowEngine.startExistingProject()` (error + success)
+
+---
+
+## Key Implementation Details
+
+### AIWorkflowEngine
+- **Location:** `lib/ai-workflow.js`
+- **Lines:** ~380
+- **Methods:**
+  - `startNewProject()` - Returns interview workflow
+  - `processInterviewAnswer()` - Progresses interview, returns recommendations
+  - `analyzeCodebase()` - Scans existing project
+  - `identifyGaps()` - Finds missing pieces
+  - `analyzeRequirements()` - Generates stack recommendations
+
+### Enhanced CLI
+- **Location:** `bin/gigaspec.js`
+- **New Commands:**
+  - `interview` - Process interview answers
+  - `continue` - Get current task for AI
+  - `verify` - Verify code compliance
+  - Enhanced `init` with `--type` flag
+  - Enhanced `analyze` with `--path` flag
+
+### Module Exports
+Updated `lib/index.js` to export:
+- `GigaspecFramework`
+- `AIWorkflowEngine` (NEW)
+- `templates`
+- `ANALYSIS_PROMPT`
+- `QUESTION_ANSWER_PROMPT`
+- `PROJECT_QUESTIONS`
+- `STACK_QUESTIONS`
+
+---
+
+## User Workflow
+
+### New Project (AI-Driven)
+
+1. **AI runs:** `gigaspec init --json`
+2. **AI asks user:** "New or existing?"
+3. **User:** "New"
+4. **AI runs:** `gigaspec init --type new --json`
+5. **AI gets first question**
+6. **AI asks user:** "What is the main purpose?"
+7. **User answers**
+8. **AI runs:** `gigaspec interview --answer "..." --json`
+9. **Repeat for 8 questions**
+10. **AI gets recommendations**
+11. **AI presents options to user**
+12. **User selects stack**
+13. **AI runs:** `gigaspec generate --name "X" --stack "Y"`
+14. **Specs generated**
+15. **AI runs:** `gigaspec continue --json`
+16. **AI implements tasks, guided by specs**
+
+### Existing Project (AI-Driven)
+
+1. **AI runs:** `gigaspec init --type existing --path . --json`
+2. **AI gets analysis:** Detected stack, gaps, questions
+3. **AI asks user about gaps**
+4. **AI generates specs matching existing code**
+5. **AI continues with spec-driven development**
+
+---
+
+## Quality Assurance
+
+### Syntax Checks
+All JavaScript files pass `node --check`
+
+### Test Results
+```
+PASS test/gigaspec.test.js
+  GigaspecFramework
+    ✓ createAnalysisPrompt
+    ✓ createRefinementPrompt
+    ✓ parseAnalysis
+    ✓ generate (files)
+    ✓ generate (infrastructure)
+  analyzeCommand
+    ✓ outputs JSON
+  generateCommand
+    ✓ generates from config
+    ✓ handles missing config
+  AIWorkflowEngine
+    ✓ startNewProject
+    ✓ processInterviewAnswer (continue)
+    ✓ processInterviewAnswer (complete)
+    ✓ startExistingProject (error)
+    ✓ startExistingProject (success)
+
+13 passed, 13 total
+```
+
+### Code Quality
+- No TODO/FIXME comments
+- No debug console.log statements
+- Consistent error handling
+- Proper async/await usage
+- JSON output for all AI-facing commands
+
+---
+
+## Documentation
+
+### README.md Updated
+- Quick start for AI assistants
+- AI-native workflow commands
+- Examples for all commands
+- Common stacks reference
+
+### Generated GETTING_STARTED.md
+Every project gets a user guide explaining:
+- What each file does
+- Step-by-step workflow
+- How to work with AI assistants
+- How to track progress
+
+---
+
+## Dependencies
+
+```json
+{
+  "@modelcontextprotocol/sdk": "^1.26.0",
+  "chalk": "^4.1.2",
+  "commander": "^11.0.0",
+  "fs-extra": "^11.1.1",
+  "inquirer": "^9.3.8",
+  "zod": "^4.3.6",
+  "zod-to-json-schema": "^3.25.1"
+}
+```
+
+---
+
+## Status
+
+✅ **Implementation Complete**
+
+All requested features implemented:
+- AI-native workflow
+- New/existing project detection
+- AI-guided interview
+- Codebase analysis
+- Stack recommendations
+- Automated spec-driven development
+- MCP server integration
+- Comprehensive test coverage
+- Updated documentation

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Gigaspec Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/PLAN.md

@@ -0,0 +1,37 @@
+# PLAN.md - Development Roadmap
+
+> **Project**: Gigaspec  
+> **Duration**: 12 weeks  
+> **Stack**: Node.js/Express  
+
+---
+
+## 🎯 Project Phases
+
+
+| Phase | Weeks | Focus | Milestone |
+|-------|-------|-------|-----------|
+| 1 | 1-3 | Foundation | Dev setup, CI/CD, core architecture |
+| 2 | 4-7 | Core Features | Main functionality |
+| 3 | 8-10 | Integration | External services, polish |
+| 4 | 11-12 | Hardening | Testing, performance, launch |
+
+---
+
+## ⚠️ Risk Mitigation
+
+| Risk | Likelihood | Impact | Mitigation |
+|------|------------|--------|------------|
+| Scope creep | High | Medium | Strict MVP definition |
+| Technical debt | Medium | High | Code reviews, AGENT.md compliance |
+| Integration issues | Medium | Medium | Early integration testing |
+
+---
+
+## ✅ Definition of Done
+
+- [ ] Code follows AGENT.md
+- [ ] Tests >90% coverage
+- [ ] Code reviewed
+- [ ] Documentation updated
+- [ ] STATE.md updated