Last Updated: October 2026

Getting Started

Yamlr is the Kubernetes Configuration Resolution Plane. It audits, validates, and deterministically heals Kubernetes manifests before deployment.

Yamlr executes 100% locally. Zero cluster credentials required, zero telemetry phoning home, and zero manifest data egressing your environment.

1. Installation

Install Yamlr using the official verified installer script or package managers:

Linux & macOS

bash
curl -fsSL https://get.yamlr.dev/install.sh | bash

Windows (PowerShell)

powershell
irm https://yamlr.dev/install.ps1 | iex

Homebrew (macOS / Linux)

bash
brew install yamlr

Verification

Verify that the native binary is installed and operational:

bash
yamlr version

Output:

text
yamlr 0.1.0 (x86_64-unknown-linux-gnu)
Release: v0.1.0 • Schema Catalog: K8s 1.30 (Built-in)

2. Your First Manifest Audit

Navigate to any directory containing Kubernetes manifests and run:

bash
yamlr scan .

Yamlr will instantly:

  1. Parse all standard manifests and Custom Resource Definitions (CRDs).
  2. Build an in-memory cross-resource topological dependency graph.
  3. Identify semantic integrity failures (e.g., Service-to-Pod selector mismatches, dead Ingress routes, unmounted Secrets).
  4. Output actionable diagnostic findings with line references.

Scan mode is strictly read-only. It will never modify files on disk.

3. Deterministic Remediation (Healing)

To preview automated remediations without touching files:

bash
yamlr heal manifests/ --dry-run
# or inspect the color-coded unified diff:
yamlr diff manifests/

To commit verified remediations atomically:

bash
yamlr heal manifests/ --apply

If you ever wish to revert changes, execute an instant atomic rollback:

bash
yamlr rollback manifests/

4. Built-in Interactive Demo

To test Yamlr's resolution capabilities against intentionally broken manifests without touching your own code:

bash
yamlr demo
yamlr heal yamlr-demo/ --dry-run

Next Steps

Next Core Concepts