Templates

Templates are project starters.

They copy files into your current folder. After that, the folder is a normal Yeast project that you can edit.

List Built-In Templates

yeast init --templates

yeast init --list-templates is the longer form of the same command.

For scripts:

yeast init --templates --json

Built-in templates in v1.1:

Template	Category	Purpose
ubuntu-basic	vm	minimal Ubuntu VM starter
caddy-single-vm	app	one Ubuntu VM with Caddy provisioning
two-vm-lab	lab	two Ubuntu VMs on one private network

Create From A Built-In Template

mkdir my-yeast-project
cd my-yeast-project
yeast init --template ubuntu-basic

Inspect the result:

ls -la
cat yeast.yaml

Create From A Local Template Directory

A local template is a folder with template.yaml plus the files listed inside it.

Example template.yaml:

name: local-ubuntu-basic
title: Local Ubuntu Basic
description: Local reusable Ubuntu starter for Yeast.
category: vm
version: "1"
files:
  - yeast.yaml
  - README.md

Use it:

mkdir project-from-local-template
cd project-from-local-template
yeast init --template ../local-ubuntu-basic

Template Rules

• Template files are copied into the project folder.
• A template does not create a special project type.
• After yeast init, edit yeast.yaml normally.
• Local templates are useful for repeating your own lab layout.

Verify A Template Project

yeast up
yeast status
yeast down
yeast destroy

Good Next Step

Try Templates And Reusable Labs for a full walkthrough.