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

Plugins

Plugin Reference

Technical reference for CyanPrint plugins

Plugin Reference

Technical documentation for the CyanPrint plugin system.

This reference is organized into two main sections: Project Setup covers the structural files required to build and configure a plugin, while SDK Reference provides detailed documentation for the TypeScript SDK used to implement plugin logic.

Project Setup

Project Structure

Standard directory layout and required files for plugin projects

cyan.yaml

Configuration file for plugin metadata and config schema

Dockerfile

Container configuration for CyanPrint plugins

SDK Reference

SDK Overview

Introduction to the plugin SDK

StartPluginWithLambda

Entry point for plugin logic

Plugin Input/Output

Type definitions for plugin interfaces

Type Definitions

Complete type reference

Push to Registry

Build and publish your plugin to a container registry

Plugin Project Structure

Standard directory layout for plugin projects

On this page

Plugin Reference