Skip to content

Prerequisites

Before installing the DK CLI, make sure you have the following tools installed and configured.

Required Tools

Go 1.22+

The DK CLI is built with Go. You'll need Go 1.22 or later to build from source.

brew install go

# Download and install Go
wget https://go.dev/dl/go1.22.0.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.22.0.linux-amd64.tar.gz

# Add to PATH (add to ~/.bashrc or ~/.zshrc)
export PATH=$PATH:/usr/local/go/bin

Download from go.dev/dl and follow the installation instructions.

Verify your installation:

go version
# Expected: go version go1.22.x ...

Docker

Docker is required for local development and running pipelines.

Install Docker Desktop for Mac.

Install Docker Engine for your distribution.

# Ubuntu example
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io

# Add your user to the docker group
sudo usermod -aG docker $USER

Podman can be used as a Docker alternative:

# macOS
brew install podman
podman machine init
podman machine start

# Set Docker compatibility
alias docker=podman

Verify Docker is running:

docker info
# Should show Docker version and system info

kubectl (Optional)

Required only for Kubernetes operations like dk promote to production.

brew install kubectl

curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl

Verify kubectl:

kubectl version --client

System Requirements

Component Minimum Recommended
CPU 2 cores 4+ cores
RAM 4 GB 8+ GB
Disk 10 GB free 20+ GB free
OS macOS 12+, Linux (kernel 4.15+) Latest macOS or Ubuntu LTS

Network Requirements

The DK CLI requires network access to:

Destination Purpose
github.com Source code, releases
ghcr.io OCI registry for packages
registry.hub.docker.com Base container images

Behind a Proxy?

Configure Docker and Go to use your proxy:

# Docker proxy
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080

# Go proxy
export GOPROXY=https://proxy.golang.org,direct

Next Steps

Once you have all prerequisites installed, proceed to:

Install the DK CLI →