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
AI-powered website cloning, analysis, and project generation tool with a beautiful terminal interface.
Site Sculptor is a revolutionary CLI tool that combines the power of AI with web development automation. Clone any website, generate projects from templates, and enhance them with modern features - all from your terminal!
✨ Features
🌐 Website Cloning
- Clone any website with assets (images, CSS, JS)
- Auto-enhance with vanilla JavaScript animations
- Smart port detection and local serving
- Cross-platform compatibility
🎨 AI Project Generation
- 15+ project templates (games, portfolios, dashboards)
- Beginner-friendly, clean code generation
- Powered by OpenAI GPT-4
- Instant project scaffolding
🔍 Website Analysis
- SEO analysis and recommendations
- Technology stack detection
- Performance insights
- Accessibility checks
🎯 Beautiful Terminal UI
- Stunning ASCII art banners
- Interactive command interface
- Real-time progress indicators
- Colorful, intuitive feedback
🚀 Quick Start
Installation
# Install globally via NPM
npm install -g site-sculptor
# Or use with npx (no installation required)
npx site-sculptorSetup
# First-time setup (configure OpenAI API key)
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
📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments
- OpenAI for GPT-4 API
- The amazing Node.js community
- All contributors and users
📞 Support
- 🐛 Report Issues
- 💬 Discussions
- 📧 Email: rishisingh1034@gmail.com
Made with ❤️ by Rishi Singh
Transform your web development workflow with AI-powered automation!