Package Exports

site-sculptor
site-sculptor/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (site-sculptor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🎨 Site Sculptor

🚀 The ultimate AI-powered website cloning, analysis, and project generation CLI tool

Site Sculptor transforms your web development workflow with intelligent automation. Clone any website, generate production-ready projects from 15+ templates, and enhance them with modern features - all through a stunning terminal interface powered by OpenAI GPT-4.

✨ NEW in v1.1.0: Automatic API key setup, enhanced project generation, robust server management, and beautiful terminal UI!

✨ Features

🌐 Intelligent Website Cloning

Complete Asset Download: Images, CSS, JS, fonts, and media files
Smart Enhancement: Auto-adds animations, interactivity, and modern features
Local Development Server: Automatic port detection (8000-8100) with conflict resolution
Cross-Platform: Works seamlessly on Windows, macOS, and Linux
Link Rewriting: Converts external links for local serving

🎨 AI-Powered Project Generation

15+ Professional Templates: Games, portfolios, web apps, dashboards, and business sites
GPT-4 Integration: Advanced AI generates clean, functional, beginner-friendly code
Chain-of-Thought Processing: 5-step reasoning for high-quality output
Zero Placeholders: Always generates complete, working code
Instant Scaffolding: Projects ready to run in seconds

🔍 Comprehensive Website Analysis

SEO Audit: Meta tags, headings, performance recommendations
Technology Detection: Frameworks, libraries, and tools identification
Performance Insights: Load times, optimization suggestions
Accessibility Checks: WCAG compliance and improvement tips

🎯 Stunning Terminal Experience

Rainbow ASCII Art: Beautiful figlet banners with gradient effects
Interactive Interface: Natural language command processing
Real-Time Feedback: Progress spinners, loading indicators, and status updates
Professional Tables: Organized data display with cli-table3
Color-Coded Output: Intuitive visual feedback with chalk styling

🔧 Production-Ready Features

Automatic Setup: First-run API key configuration
Robust Error Handling: Graceful failures with helpful messages
Memory System: Conversation context and user preferences
Port Management: Smart conflict resolution and cleanup utilities
Server Monitoring: Track and manage multiple running servers

🚀 Quick Start

Installation

# Install globally via NPM
npm install -g site-sculptor

# Or use with npx (no installation required)
npx site-sculptor

# Alternative command alias
npm install -g site-sculptor
sculptor  # Short alias for site-sculptor

First-Time Setup

🎉 NEW: Automatic Setup! Site Sculptor now automatically prompts for API key setup on first run.

# Just run the tool - it will guide you through setup
site-sculptor
# → "🔧 First time setup required!"
# → Guides through OpenAI API key configuration
# → "✅ Setup complete! Welcome to Site Sculptor!"

# Or manually configure
site-sculptor setup

Usage

# Start interactive mode
site-sculptor

# Clone a website
site-sculptor clone https://example.com

# Generate a project
site-sculptor build snake-game

# Show available templates
site-sculptor templates

# Get help
site-sculptor --help

🎮 Available Commands

Website Commands

clone <url> - Clone and enhance any website
analyze <url> - Analyze website technologies and SEO
serve <directory> - Serve local files with live server

Project Generation

build <project-name> - Generate a project from templates
templates - Show all available project templates
search <keyword> - Find specific templates

Utility Commands

setup - Configure OpenAI API key and preferences
config - Show current configuration
servers - List running servers
stop - Stop all running servers
help - Show detailed help

🎨 Project Templates

🎮 Games

snake-game - Classic Snake game with modern UI
memory-game - Card matching memory game
tic-tac-toe - Interactive Tic-Tac-Toe
rock-paper-scissors - Animated RPS game

💼 Portfolios

developer-portfolio - Modern developer showcase
creative-portfolio - Artist/designer portfolio
minimal-portfolio - Clean, minimalist design

📱 Web Apps

todo-app - Task management application
weather-app - Weather dashboard with API
calculator - Scientific calculator
quiz-app - Interactive quiz platform

🏢 Business

landing-page - Product landing page
restaurant-menu - Digital menu system
blog-template - Personal blog layout

📊 Dashboards

admin-dashboard - Complete admin interface
analytics-dashboard - Data visualization panel

🛠️ Requirements

Node.js >= 16.0.0
Python 3 (for local server functionality)
OpenAI API Key (for project generation)

⚙️ Configuration

Site Sculptor stores configuration in ~/.site-sculptor/config.json:

{
  "openaiApiKey": "your-api-key-here",
  "defaultOutputDir": "./clones",
  "theme": "dark",
  "autoServe": true
}

Getting OpenAI API Key

Visit OpenAI Platform
Create a new API key
Run site-sculptor setup to configure

🌟 Examples

Clone and Enhance a Website

site-sculptor clone https://github.com
# Clones GitHub homepage with enhancements
# Auto-serves on available port (8000, 8001, etc.)

Generate a Snake Game

site-sculptor build snake-game
# Creates a complete Snake game
# Includes HTML, CSS, JavaScript
# Auto-opens in browser

Interactive Mode

site-sculptor
# Starts beautiful interactive CLI
# Natural language commands supported
# "build a portfolio" or "clone reddit.com"

🔧 Advanced Features

Smart Port Management

Automatically finds available ports (8000-8100)
Handles port conflicts gracefully
Multiple servers can run simultaneously

Enhanced Website Cloning

Downloads all assets (images, CSS, JS, fonts)
Rewrites links for local serving
Adds modern enhancements:
- Smooth animations
- Interactive buttons
- Responsive navigation
- Keyboard shortcuts

AI-Powered Generation

Context-aware project creation
Beginner-friendly code output
Modern web standards
Fully functional projects

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

🚀 What's New in v1.1.0

✨ Major Improvements

🔧 Automatic API Key Setup: No more manual configuration - setup happens on first run
🎯 Enhanced Project Generation: Chain-of-thought AI processing for superior code quality
🌐 Robust Server Management: Smart port detection, conflict resolution, and cleanup
🎨 Beautiful Terminal UI: Stunning ASCII art, colors, and professional interface
📦 Zero Placeholder Policy: Always generates complete, functional code
🔄 Improved Error Handling: Graceful failures with helpful recovery suggestions

🐛 Bug Fixes

Fixed terminal freezing after server startup
Resolved port conflict issues
Enhanced cross-platform compatibility
Improved AI response parsing and validation

📈 Roadmap

🔮 Coming Soon (v1.2.0)

🎨 Custom Template Creator: Build your own project templates
🌍 Multi-Language Support: Templates in React, Vue, Angular
☁️ Cloud Deployment: One-click deploy to Netlify, Vercel, GitHub Pages
🔄 Live Sync: Real-time collaboration features

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

OpenAI for providing the incredible GPT-4 API
Node.js Community for the amazing ecosystem
All Contributors who make this project better every day
Users who provide feedback and feature requests
Open Source Libraries: figlet, chalk, boxen, cli-table3, ora, and many more

📞 Support & Community

Made with ❤️ by Rishi Singh

Transform your web development workflow with AI-powered automation! 🚀