Skip to main content

Introduction

Welcome to Archetect, a powerful and flexible code generator that helps you bootstrap projects, generate boilerplate code, and maintain consistency across your development workflow.

What is Archetect?​

Archetect is a sophisticated code generator that combines:

  • Powerful CLI: Easy-to-use command-line interface for generating code from templates
  • Rhai Scripting: Embedded scripting engine for complex generation logic
  • Advanced Templating: Custom fork of MiniJinja with enhanced features
  • Interactive Prompts: Rich terminal UI for gathering user input
  • String Transformations: Comprehensive case conversion and inflection utilities

Key Features​

  • 🚀 Fast Generation: Efficient Rust-based engine for quick code generation
  • 🎯 Flexible Templates: Jinja2-compatible templating with custom enhancements
  • 🔄 Interactive Workflows: Rich prompts for gathering project requirements
  • 📦 Archetype Catalogs: Organized collections of related templates
  • 🛠️ Scriptable Logic: Rhai scripting for complex generation scenarios
  • 🎨 String Transformations: Built-in case conversions and inflections
  • 📋 Configuration Management: Flexible YAML-based configuration

Getting Started​

Ready to dive in? Start with our Installation Guide to get Archetect up and running, then follow our Quick Start Tutorial to generate your first project.

Documentation Structure​

This documentation is organized into several main sections:

  • Getting Started: Installation, quick start, and basic concepts
  • User Guide: Using Archetect to generate code from existing archetypes
  • Authoring Guide: Creating your own archetypes and templates
  • Reference: Complete CLI reference and configuration guide