Template Basics

Environment templates define the configuration, resources, and settings for your simulation environments. This guide covers the fundamentals of creating and working with templates.

Template Structure

A wirtual.dev template consists of:

Configuration

  • Environment settings

  • Hardware requirements

  • Network configuration

  • Storage specifications

Parameters

  • Simulation settings

  • Sensor configurations

  • Environment variables

  • Build options

Creating Templates

Initialize Template

Start with a pre-built template or create from scratch:

wirtual templates init --id devcontainer-docker
cd my-template

Configure Settings

Templates support various configuration options:

# Set default parameters
wirtual templates push my-template \
    --parameter "simulation_type=training" \
    --parameter "gpu_enabled=true"

# Configure provisioner
wirtual templates push my-template \
    --provisioner-tag "gpu=true" \
    --provisioner-tag "region=us-west"

Test Template

Verify your template works as expected:

# Create test workspace
wirtual create test-env --template my-template

# Verify environment
wirtual show test-env

Template Components

Parameter Types

Templates support different parameter types for customization:

Rich Parameters

Persistent configuration values that affect the environment setup

wirtual create env --parameter "robot_type=ur5"

Build Options

One-time build configuration options

wirtual create env --build-option "debug=true"

Version Control

Manage template versions effectively:

1

Create Version

wirtual templates push my-template \
    --message "Added new sensor config"
2

List Versions

wirtual templates versions list my-template
3

Promote Version

wirtual templates versions promote \
    --template my-template \
    --template-version v1.0

Next Steps