Skip to main content

Getting Started

Welcome to the Zarf documentation! This page runs through a quick start to test Zarf on your machine and walks through next steps to get more familiar with Zarf's concepts. Let's get started!

Quick Start

Trying out Zarf is as simple as:

  1. 💻 Selecting your system's OS below.
  2. ❗ Ensuring you have the pre-requisite applications running.
  3. $ Entering the commands into your terminal.

This quick start requires you to already have:

  • Homebrew package manager installed on your machine.
  • Docker installed and running on your machine.

For more install options please visit our Installing Zarf page.

macOS Commands

# To install Zarf with Homebrew simply run:
brew tap defenseunicorns/tap && brew install zarf

# Next, you will need a Kubernetes cluster. This example uses KIND.
brew install kind && kind delete cluster && kind create cluster

# Then, you need to initialize the cluster with Zarf:
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://🦄/dos-games:1.0.0-$(uname -m) --key=
# (Select 'Y' to confirm deployment)

Where to Next?

Depending on how familiar you are with Kubernetes, DevOps, and Zarf, let's find what set of information would be most useful to you.

  • If you want to become more familiar with Zarf and it's features, see the Tutorials page.

  • More information about the Zarf CLI is available on the Zarf CLI page, or by browsing through the help descriptions of all the commands available through zarf --help.

  • More information about the packages that Zarf creates and deploys is available in the Understanding Zarf Packages page.

  • If you want to take a step back and better understand the problem Zarf is trying to solve, you can find more context on the Understand the Basics and Core Concepts pages.