Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/getployz/ployz/llms.txt

Use this file to discover all available pages before exploring further.

Ployz turns cluster operations into explicit, atomic commands. Instead of writing manifests and waiting for reconcilers, you run ployzctl deploy, ployzctl branch, or ployzctl migrate — each command completes or fails cleanly, every time. Ployz targets clusters in the 1–200 node range: small enough to reason about end-to-end, large enough to matter.

Quickstart

Go from a fresh machine to a running cluster in under five minutes.

Installation

Install ployzctl and the daemon on Linux or macOS.

Core Concepts

Understand what makes Ployz different from Kubernetes and other orchestrators.

CLI Reference

Every ployzctl command, flag, and option, documented with examples.

What Ployz does

Ployz gives you a small set of strong operations — primitives — that compose into any workflow you need. There are no controllers, no autoscalers, and no background reconcilers silently rewriting cluster state.

Machine operations

Add and remove machines. Drain workloads before removal.

Deploy

Deploy workloads from a manifest or inline flags. Preview before applying.

Branch & promote

Fork an environment atomically for a PR, then promote it to production.

Migrate

Move a workload and its persistent state to a different machine.

How it works

1

Install ployz

Run the one-line installer to get ployzctl and the ployzd daemon on your machine.
curl -fsSL https://ployz.sh | bash -s -- install
2

Create a cluster network

Initialize a WireGuard mesh network that your machines will join.
ployzctl mesh init my-cluster
3

Add machines

Provision additional machines into your cluster with a single command.
ployzctl machine add --network my-cluster user@192.168.1.10
4

Deploy your first workload

Deploy a container image to your cluster.
ployzctl deploy -f deploy.toml
Ployz runs on Linux and macOS. On macOS, the daemon uses the Docker runtime (Docker Desktop or OrbStack required). On Linux, you can use either the Docker or host runtime.

Build docs developers (and LLMs) love