Getting Started

Quick Start

1. Install Zarf

2. Install a Kubernetes cluster (e.g. kind)

3. Interactive

   # Startup a fresh kind cluster
   kind delete cluster && kind create cluster
   
   zarf init
   # (Select 'Y' to download the default init package)
   # (Select 'Y' to confirm deployment)
   # (Select optional components as desired)
   
   # Now you are ready to deploy any Zarf Package, try out our Retro Arcade!!
   zarf package deploy oci://ghcr.io/zarf-dev/packages/dos-games:1.1.0 --key=https://zarf.dev/cosign.pub
   # (Select 'Y' to confirm deployment)

   Non-interactive

   # Startup a fresh kind cluster
   kind delete cluster && kind create cluster
   
   # Download the default init package and deploy it
   zarf tools download-init
   zarf init --confirm
   
   # Deploy the DOS Games package
   zarf package deploy oci://ghcr.io/zarf-dev/packages/dos-games:1.1.0 \
      --key=https://zarf.dev/cosign.pub \
      --confirm

4. Join us on the Kubernetes Slack in the #zarf channel or the #zarf-dev channel!

Where to Next?

Understanding the Basics

Create a Package

View tutorials

Discover CLI commands (zarf --help)