site-sculptor
v1.1.3
Published
๐ Ultimate AI-powered CLI tool for website cloning, analysis, and project generation with 15+ templates. Features automatic setup, beautiful terminal UI, and GPT-4 integration.
Maintainers
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-sculptorFirst-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 setupUsage
# 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 websiteanalyze <url>- Analyze website technologies and SEOserve <directory>- Serve local files with live server
Project Generation
build <project-name>- Generate a project from templatestemplates- Show all available project templatessearch <keyword>- Find specific templates
Utility Commands
setup- Configure OpenAI API key and preferencesconfig- Show current configurationservers- List running serversstop- Stop all running servershelp- Show detailed help
๐จ Project Templates
๐ฎ Games
snake-game- Classic Snake game with modern UImemory-game- Card matching memory gametic-tac-toe- Interactive Tic-Tac-Toerock-paper-scissors- Animated RPS game
๐ผ Portfolios
developer-portfolio- Modern developer showcasecreative-portfolio- Artist/designer portfoliominimal-portfolio- Clean, minimalist design
๐ฑ Web Apps
todo-app- Task management applicationweather-app- Weather dashboard with APIcalculator- Scientific calculatorquiz-app- Interactive quiz platform
๐ข Business
landing-page- Product landing pagerestaurant-menu- Digital menu systemblog-template- Personal blog layout
๐ Dashboards
admin-dashboard- Complete admin interfaceanalytics-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 setupto 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 browserInteractive 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
- ๐ Report Issues
- ๐ฌ Join Discussions
- ๐ง Email: [email protected]
- ๐ฆ Twitter: @rishisingh1034
- ๐ Star on GitHub
Made with โค๏ธ by Rishi Singh
Transform your web development workflow with AI-powered automation! ๐
