Skip to content

Noble-TS/skipsetup-ai-context

Repository files navigation

#  @skipsetup/generate@latest - AI-Powered Project Context Generator

Generate comprehensive `.kiro/` directories that make your projects AI-agent ready with specialized tooling.

[![npm version](https://badge.fury.io/js/@skipsetup%2Fgenerate.svg)](https://www.npmjs.com/package/ @skipsetup/generate@latest)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Quick Start

```bash
# 1. Get a free Groq API key
#    Visit: https://console.groq.com/keys

# 2. Set the API key as environment variable
export GROQ_API_KEY=your_api_key_here

# 3. Generate .kiro/ for any project
npx  @skipsetup/generate@latest generate /path/to/project

# Example: Generate for a Next.js project
npx  @skipsetup/generate@latest generate ~/projects/my-nextjs-app

What You Get

After running the generator, your project gets a complete .kiro/ directory:

.kiro/
├── agents/           # Specialized AI agents (auth, database, fullstack)
├── specs/           # Project specifications
├── steering/        # Architecture documentation
├── mcp/            # Model Context Protocol configs
└── hooks/          # Development automation

Requirements

  1. Groq API Key (free from https://console.groq.com)
  2. Node.js 18+
  3. Project with package.json

Step-by-Step Guide

Step 1: Get Your Groq API Key

# 1. Visit https://console.groq.com
# 2. Sign up or log in
# 3. Navigate to "API Keys"
# 4. Click "Create API Key"
# 5. Copy your key

Step 2: Set the API Key

# Set as environment variable (Linux/Mac)
export GROQ_API_KEY=your_api_key_here

# Or set it temporarily for one command
GROQ_API_KEY=your_key_here npx  @skipsetup/generate@latest generate .

# On Windows (Command Prompt)
set GROQ_API_KEY=your_api_key_here

# On Windows (PowerShell)
$env:GROQ_API_KEY="your_api_key_here"

Step 3: Generate Your AI Context

# Generate for current directory
npx  @skipsetup/generate@latest generate .

# Generate for specific project
npx  @skipsetup/generate@latest generate ~/projects/your-project

# Generate for sibling directory
npx  @skipsetup/generate@latest generate ../project-name/

Example Output

$ npx  @skipsetup/generate@latest generate ~/projects/gifttigray/

Discovery complete in 4790ms
AI analysis complete

Patterns Found: 22
Relationships: 15
Recommendations: 13
Confidence: 95%

Specialized Agents Created:
• auth-expert - Authentication & Authorization specialist
• database-architect - Database schema & query specialist
• fullstack-specialist - Complete fullstack development

Generated .kiro/ directory with AI-ready context!

What Gets Generated

AI Agents (3 specialized agents)

  1. auth-expert - Authentication and authorization specialist
  2. database-architect - Database schema and query expert
  3. fullstack-specialist - Complete fullstack development assistant

Project Specifications

  • API specifications and endpoints
  • Component specifications and props
  • Database schema and relationships

Architecture Documentation

  • Master project index
  • Architecture documentation
  • Development workflows
  • Plugin intelligence
  • Project blueprint

MCP Configuration

  • Model Context Protocol resources
  • Tools for AI integration
  • Prompts for AI assistants

Development Hooks

  • Pre-commit validation
  • Post-generation tasks
  • Pre-deploy checks
  • Schema validation

What It Analyzes

  • Framework Detection: Next.js, React, Node.js, etc.
  • Authentication Patterns: Auth providers, flows, security
  • Database Schema: Models, relationships, migrations
  • API Structure: Endpoints, middleware, patterns
  • Components: React components, props, dependencies
  • State Management: Patterns and libraries used
  • Dependencies: Auth, database, UI, state, API libraries

Real Example

# 1. Set API key
export GROQ_API_KEY=gsk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# 2. Generate context
npx  @skipsetup/generate@latest generate projects/gifttigray/

# Output shows:
# - 417 files scanned
# - 241 files parsed
# - 22 patterns detected
# - 15 relationships found
# - 13 recommendations
# - 95% confidence score
# - 3 specialized agents created

# 3. Review generated context
cd projects/gifttigray/.kiro
ls -la

# You'll see:
# agents/ specs/ steering/ mcp/ hooks/

Troubleshooting

Error: "API key required"

# Solution: Set your Groq API key
export GROQ_API_KEY=your_actual_key_here

Error: "Invalid API key"

# Solution: Get a new key from https://console.groq.com
# Make sure you copy the entire key

Error: Project not found

# Solution: Use full path or correct relative path
npx  @skipsetup/generate@latest generate ./project
npx  @skipsetup/generate@latest generate /home/user/projects/my-app

Performance

  • Fast scanning: ~5 seconds for 400+ files
  • Accurate parsing: Real code analysis, not just file names
  • AI-powered: Uses Groq AI for pattern recognition
  • Comprehensive: Generates complete AI-ready context

Usage with AI Tools

The generated .kiro/ directory works with:

  • Claude Desktop (via MCP)
  • Cursor AI
  • Any MCP-compatible AI tool

API Key Security Tips

  1. Never commit API keys to version control
  2. Use environment variables as shown above
  3. Rotate keys regularly from Groq console
  4. Set usage limits in Groq dashboard if needed

Commands

Command Description
generate [path] Generate .kiro/ directory for project
scan [path] Analyze project without generating .kiro/

Examples

# Generate with temporary API key
GROQ_API_KEY=your_key npx  @skipsetup/generate@latest generate .

# Generate for multiple projects
export GROQ_API_KEY=your_key
npx  @skipsetup/generate@latest generate ~/projects/app1
npx  @skipsetup/generate@latest generate ~/projects/app2
npx  @skipsetup/generate@latest generate ~/projects/app3

# Scan to preview what would be generated
npx  @skipsetup/generate@latest scan .

How It Works

  1. Discovery Phase: Scans project structure and parses code files
  2. AI Analysis: Uses Groq AI to identify patterns and relationships
  3. Context Generation: Creates specialized agents and documentation
  4. Directory Creation: Builds complete .kiro/ structure

Development

# Clone the repository
git clone https://github.com/Noble-TS/skipsetup-ai-context.git
cd skipsetup-ai-context

# Install dependencies
npm install

# Build the project
npm run build

# Test locally (requires GROQ_API_KEY)
export GROQ_API_KEY=your_test_key
npm run generate .

Support

License

MIT © SkipSetup Team


Ready to make your project AI-ready?

# Get your free API key: https://console.groq.com
# Then run:
export GROQ_API_KEY=your_key
npx  @skipsetup/generate@latest generate .

Your AI development workflow starts here!

About

Generate comprehensive `.kiro/` directories that make your projects AI-agent ready with specialized tooling.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published