Scaffoldfy Documentation

Welcome to the official documentation for @pixpilot/scaffoldfy (formerly scaffoldfy) - a flexible and powerful template initialization utility for automating project setup, cleanup, and configuration tasks.

📝 Note: This documentation is available at GitHub Pages with a convenient navigation sidebar.

🚀 Quick Start

New to Scaffoldfy? Start here:

1. Quick Reference - Essential commands and examples to get started in minutes
2. Getting Started Guide - Detailed installation and setup instructions
3. Task Types Reference - Learn about all available task types

📚 Table of Contents

Getting Started

• Getting Started Guide - Installation, CLI usage, and programmatic API examples

Core Concepts

• Task Types Reference - Complete reference for all built-in task types
• Interactive Prompts - Collect user input with various prompt types
• Variables - Define reusable values without user interaction
• Value Transformers - Transform prompt and variable values
• Prompts Quick Reference - Quick syntax reference for prompts

Advanced Features

• Advanced Features Guide - Conditional execution, variables, and Handlebars templates
• Configuration Inheritance - Extend and compose configurations for code reuse
• Handlebars Templates - Advanced templating with conditionals, loops, and helpers
• Plugin System - Create custom task types and lifecycle hooks
• Dry Run Mode - Preview changes with detailed diffs before applying

References

• Executable Defaults Reference - Default values for executable tasks

🚀 Quick Links

Essential Reading

1. Getting Started - Start here if you’re new
2. Task Types Reference - Learn about available task types
3. Interactive Prompts - Make your configurations interactive

Common Use Cases

Setting up a new project? → Getting Started Guide + Task Types Reference

Need user input? → Interactive Prompts + Prompts Quick Reference

Need dynamic values without user input? → Variables

Need to transform user input or values? → Value Transformers

Building complex templates? → Configuration Inheritance + Handlebars Templates

Want to preview changes first? → Dry Run Mode

Extending with custom functionality? → Plugin System

Using conditional logic? → Advanced Features Guide

💡 Features at a Glance

• 🧩 Configuration Inheritance - Extend base configurations for code reuse
• 🔍 Dry-Run Mode with Diff - Preview exact changes before applying
• 🔌 Plugin System - Create custom task types and lifecycle hooks
• 💬 Interactive Prompts - Collect user input with 5 prompt types
• 📦 JSON/TypeScript Config - Define tasks in JSON or TypeScript files
• 🔗 Task Dependencies - Ensure tasks run in the correct order
• ✅ Type-Safe - Full TypeScript support with JSON schema validation
• 🎯 Template Variables - Use `` syntax for dynamic configuration
• 📝 Handlebars Support - Advanced templating with conditionals, loops, and helpers
• ⚡ CLI & Programmatic - Use as a command-line tool or import as a library

🤝 Contributing

Found an issue or want to improve the docs? Contributions are welcome!

• Main Repository
• Report Issues

📄 License

MIT License - see the LICENSE file for details.