Developer Overview

Introduction Architecture

Tutorial 1 - Blank Template Tutorial 2 - Adding Variables Tutorial 3 - Changing Glob Patterns Tutorial 4 - Asking Questions Tutorial 5 - Flow Control Publish to Registry

Test Templates Locally Automated Testing Dev Mode for Templates Ask Checkbox Questions Ask Confirm Questions Ask Password Questions Ask Date Questions Set Default Values Validate User Input Use Keys for Consistent Answers Pin Determinism Compose Templates Pass Images and Binary Files Push to Registry Include Files Conditionally Use a Custom Processor Add Plugins to Templates

Template Project Structure cyan.yaml Reference Dockerfiles Reference Build Configuration Dev Configuration

SDK Overview IInquirer Reference Cyan Config Reference Globbing Reference Type Definitions

The Cyan Configuration Object Determinism Client State Docker Registry vs CyanPrint Registry Processors vs Plugins 3-Way Merge Container Paths Default Processor

Processor Development

Your First Processor

Resolve All Files Lazy Load Files Stream Large Files Copy Files Directly Access Processor Config Automated Testing Push to Registry

Project Structure cyan.yaml Format Processor Dockerfile

SDK Overview StartProcessorWithLambda CyanFileHelper API Processor Input/Output Type Definitions

Why Processors Exist Stateless Nature Read and Write Directories Memory Loading Input Config

Your First Resolver

Merge JSON Files Merge Text Files Automated Testing Push to Registry

Project Structure cyan.yaml Format Resolver Dockerfile

Resolver SDK StartResolver Functions Resolver Input/Output

What are Resolvers Resolvers in Pipeline

Plugin Development

Your First Plugin

Run Shell Commands Modify Generated Files Conditional Execution Automated Testing Push to Registry

Plugin Project Structure Plugin cyan.yaml Plugin Dockerfile

Plugin SDK StartPluginWithLambda Plugin Input/Output Plugin Type Definitions

What Are Plugins?Plugins vs Processors Execution Order

Template How-To Guides

Task-oriented guides for common template development tasks

Template How-To Guides

Practical guides for accomplishing specific tasks in template development.

Question Types

Ask Checkbox Questions

Multi-select questions

Ask Confirm Questions

Yes/no questions

Ask Password Questions

Hidden input

Ask Date Questions

Date selection

Input Handling

Set Default Values

Provide sensible defaults

Validate User Input

Custom validation rules

Use Keys

Keys and namespacing

Template Features

Include Files Conditionally

Feature-based file inclusion

Pass Images and Binaries

Handle binary files

Compose Templates

Combine multiple templates

Pin Determinism

Reproducible generation

Extensions

Use Custom Processor

Beyond default templating

Add Plugins

Post-generation actions

Publishing

Push to Registry

Build and publish templates

Next Steps

SDK Reference

Complete API documentation

Explanation

Understand the concepts

Publish to Registry

Learn how to publish your template to CyanPrint registry

Test Templates Locally

Test your template during development without publishing

On this page

Template How-To Guides

Template Features