Wendy LogoWendy
Installation

Developer Machine Setup

Set up your development machine with the Wendy CLI

Platform Support: The Wendy CLI currently only supports macOS and Linux. Windows support is coming soon!

CLI Installation

The Wendy CLI requires Homebrew to be installed on your system.

Once you have Homebrew installed, update it to ensure you have the latest version, then install the Wendy CLI:

brew upgrade
brew install wendylabsinc/tap/wendy

The wendy CLI is your developer tool that helps build, discover, and deploy apps to WendyOS. It can even help get WendyOS setup on your NVIDIA Jetson and Raspberry Pi 5.

Hardware Support: We officially support NVIDIA Jetson devices and Raspberry Pi 5. Raspberry Pi 3 and 4 are experimental and not officially supported yet.

Verify the installation:

wendy --version

Install Swift

While WendyOS allows you to use any language, our flagship language is Swift which offers expressiveness, type-safety, memory-safety, and excellent C and C++ interop.

curl -O https://download.swift.org/swiftly/darwin/swiftly.pkg && \
installer -pkg swiftly.pkg -target CurrentUserHomeDirectory && \
~/.swiftly/bin/swiftly init --quiet-shell-followup && \
. "${SWIFTLY_HOME_DIR:-$HOME/.swiftly}/env.sh" && \
hash -r
curl -O https://download.swift.org/swiftly/darwin/swiftly.pkg && \
installer -pkg swiftly.pkg -target CurrentUserHomeDirectory && \
~/.swiftly/bin/swiftly init --quiet-shell-followup && \
set -q SWIFTLY_HOME_DIR && source "$SWIFTLY_HOME_DIR/env.fish" || source ~/.swiftly/env.fish
curl -O https://download.swift.org/swiftly/linux/swiftly-$(uname -m).tar.gz && \
tar zxf swiftly-$(uname -m).tar.gz && \
./swiftly init --quiet-shell-followup && \
. "${SWIFTLY_HOME_DIR:-$HOME/.local/share/swiftly}/env.sh" && \
hash -r
curl -O https://download.swift.org/swiftly/linux/swiftly-$(uname -m).tar.gz && \
tar zxf swiftly-$(uname -m).tar.gz && \
./swiftly init --quiet-shell-followup && \
set -q SWIFTLY_HOME_DIR && source "$SWIFTLY_HOME_DIR/env.fish" || source ~/.local/share/swiftly/env.fish

After installation, your Mac or Linux machine should have Swift 6.2 installed. Verify the installation:

swift --version

Docker Installation

WendyOS uses containerd underneath the hood to run applications in containers. Docker is required for building and deploying applications written in Python, Rust, C++, and other languages.

Required for Non-Swift Development: Docker is required for TypeScript (JavaScript), Python, Rust, and C++ development on WendyOS. Only Swift applications can be built without Docker.

Download Docker Desktop

Download Docker Desktop for Mac (Apple Silicon)

Or Install via Homebrew (CLI)

brew install --cask docker

After installation, open Docker from your Applications folder to complete the setup.

System Requirements

  • macOS Monterey (12) or later
  • Apple Silicon (M1, M2, M3, M4, M5, etc...) processor
  • At least 4GB RAM (8GB recommended)

Download Docker Desktop

Download Docker Desktop for Linux (DEB)

Download Docker Desktop for Linux (RPM)

Or Install via CLI (Ubuntu/Debian)

Set up Docker's apt repository and install Docker Engine:

# Remove conflicting packages
for pkg in docker.io docker-doc docker-compose docker-compose-v2 podman-docker containerd runc; do sudo apt-get remove $pkg; done

# Set up Docker repository
sudo apt-get update
sudo apt-get install -y ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add Docker repository
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

# Install Docker Engine
sudo apt-get update
sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Start Docker:

sudo systemctl start docker
sudo systemctl enable docker

Other Linux Distributions

For Fedora, CentOS, RHEL, and other distributions, visit the official Docker documentation.

Download Docker Desktop

Download Docker Desktop for Windows

Or Install via CLI (Winget)

winget install Docker.DockerDesktop

System Requirements

  • Windows 10 or 11 (64-bit)
  • WSL 2 feature enabled
  • At least 4GB RAM (8GB recommended)

After installation, enable WSL 2 when prompted to allow Linux containers, restart your PC, and launch Docker Desktop from the Start menu.

Verify the installation:

docker --version

We recommend using the latest stable version of Docker (v27.5 or later as of early 2025).

Next Steps

Once you have the Wendy CLI installed, you can proceed to install WendyOS on your device: