✨ Key Features

📝

YAML-Based Configuration

Define project structures in simple, readable YAML files with intuitive syntax and validation.

🔧

Template Variables

Dynamic content with Jinja2 templating, interactive prompts, and custom filters for flexibility.

🌐

Remote Content

Fetch files from GitHub, HTTP/HTTPS, S3, and Google Cloud Storage with automatic content handling.

🛡️

Smart File Handling

Multiple strategies for managing existing files: overwrite, skip, backup, append, and more.

🪝

Automation Hooks

Pre and post-generation shell commands for complete workflow automation and integration.

🎯

Dry Run Mode

Preview changes before applying them with detailed output and validation checks.

🚀 Quick Installation

Install via pip

# Install from GitHub
pip install git+https://github.com/httpdss/struct.git

# Verify installation
struct --version

Requires Python 3.8+ and pip. This is the recommended installation method for most users.

Run with Docker

# Pull and run with Docker
docker run -v $(pwd):/workdir ghcr.io/httpdss/struct:main generate my-config.yaml ./output

# Create an alias for easier usage
alias struct='docker run -v $(pwd):/workdir ghcr.io/httpdss/struct:main'

Perfect for CI/CD environments and when you don't want to install Python locally.

Install from Source

# Clone the repository
git clone https://github.com/httpdss/struct.git
cd struct

# Install in development mode
pip install -e .

# Run tests
python -m pytest tests/

For contributors and users who want the latest development features.

🎬 Interactive Demos

Basic Project Generation

See how easy it is to generate a complete project structure with a simple YAML configuration.

YAML Configuration

Learn how to write effective YAML configurations with variables and templates.

External Mappings

Discover how to use external data mappings for dynamic project generation.

Remote Content Fetching

See how to fetch templates and content from GitHub, HTTP URLs, and cloud storage.

Advanced Features

Explore hooks, validation, dry-run mode, and other advanced capabilities.

⚡ Quick Start

1. Create Configuration

# my-project.yaml
files:
  - README.md:
      content: |
        # {{@ project_name @}}
        Generated with STRUCT

folders:
  - src/:
      struct: project/python

variables:
  - project_name:
      description: "Project name"
      type: string

2. Generate Project

# Generate structure
struct generate my-project.yaml ./my-app

# List available structures
struct list

# Validate configuration
struct validate my-project.yaml

📚 Documentation

Getting Started

Installation guides, quick start tutorials, and basic usage examples to get you up and running.

Read Guide →

Configuration

Complete YAML configuration reference, template variables, and file handling strategies.

View Reference →

Examples

Real-world examples, templates, and practical use cases for various project types.

Browse Examples →

STRUCT: