Dev Configuration

The dev: section in cyan.yaml configures dev mode for rapid local template development. When enabled with cyanprint try template --dev, it connects directly to a locally-running template server instead of building a Docker image.

Basic Structure

username: myorg
name: my-template
# ... other fields ...

dev:
  template_url: http://localhost:5550
  blob_path: ./cyan

Configuration Reference

template_url

The URL where your template server is accessible. The template server is typically started by running your template code locally.

Common values:

# Default port for TypeScript/JavaScript templates
template_url: http://localhost:5550

# Custom port
template_url: http://localhost:8080

# Full URL with path (if applicable)
template_url: http://localhost:5550/api

blob_path

Path to the directory containing your template's blob files (static files to be copied during generation). This path is used for direct filesystem access in dev mode.

# Relative path (recommended)
blob_path: ./cyan

# Absolute path
blob_path: /home/user/projects/my-template/cyan

# Subdirectory
blob_path: ./template-files

How Dev Mode Works

Normal Mode:  code ──► docker build ──► container ──► output
Dev Mode:     code ──────────────────────────────────► output

Complete Example

# Organization and identity
username: myorg
name: node-service
description: Production-ready Node.js microservice template
email: [email protected]

# Links
project: https://docs.myorg.io/templates/node-service
source: https://github.com/myorg/node-service-template
readme: README.md

# Discovery
tags:
  - nodejs
  - microservice
  - typescript

# Processor dependencies
processors:
  - myorg/base-processor

# Plugin dependencies
plugins:
  - cyan/init-git

# Dev mode configuration
dev:
  template_url: http://localhost:5550
  blob_path: ./cyan

Usage

1. Start Your Template Server

Start your template locally (typically on port 5550):

cd cyan
bun install
bun run --watch index.ts

2. Run Try with Dev Flag

cyanprint try template . ./output --dev

The command:

1. Reads the dev: section from cyan.yaml
2. Skips Docker image building
3. Validates that template_url is reachable
4. Connects directly to your template server
5. Uses blob_path for filesystem access

Related