cli/docs/cmd/vm/templates/index.md
Snider 32c465b67f docs: add templates vars section and --wait flag
- Document core vm templates vars command
- Add --wait flag example for php deploy

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-29 15:58:00 +00:00

2 KiB

core vm templates

Manage LinuxKit templates for container images.

Usage

core vm templates [command]

Commands

Command Description
list List available templates
show Show template details
vars Show template variables

templates list

List all available LinuxKit templates.

core vm templates list

Output

Available Templates:

  core-dev
    Full development environment with 100+ tools
    Platforms: linux/amd64, linux/arm64

  server-php
    FrankenPHP production server
    Platforms: linux/amd64, linux/arm64

  edge-node
    Minimal edge deployment
    Platforms: linux/amd64, linux/arm64

templates show

Show details of a specific template.

core vm templates show <name>

Example

core vm templates show core-dev

Output:

Template: core-dev

Description: Full development environment with 100+ tools

Platforms:
  - linux/amd64
  - linux/arm64

Formats:
  - iso
  - qcow2

Services:
  - sshd
  - docker
  - frankenphp

Size: ~1.8GB

templates vars

Show variables defined by a template.

core vm templates vars <name>

Example

core vm templates vars core-dev

Output:

Variables for core-dev:
  SSH_KEY      (required)  SSH public key
  MEMORY       (optional)  Memory in MB (default: 4096)
  CPUS         (optional)  CPU count (default: 4)

Template Locations

Templates are searched in order:

  1. .core/linuxkit/ - Project-specific
  2. ~/.core/templates/ - User templates
  3. Built-in templates

Creating Templates

Create a LinuxKit YAML in .core/linuxkit/:

# .core/linuxkit/myserver.yml
kernel:
  image: linuxkit/kernel:5.15
  cmdline: "console=tty0"

init:
  - linuxkit/init:v1.0.0

services:
  - name: sshd
    image: linuxkit/sshd:v1.0.0
  - name: myapp
    image: ghcr.io/myorg/myapp:latest

Run with:

core vm run --template myserver

See Also