Getting Started

Yamlr is an industrial-strength safety engine designed to eliminate "Silent Failures" in Kubernetes manifests. This guide will take you from installation to your first deterministic healing session in under 2 minutes.

[!NOTE] Prerequisite: Ensure you have completed the Downloads & Installation steps before proceeding.

⚡ 1. The 60-Second Interactive Quickstart

The fastest way to experience the Yamlr Healing Engine is through our built-in Sandbox. This allows you to witness "Sovereign Remediation" without risking your own production manifests.

Step A: Initialize the Sandbox

Navigate to a temporary directory and run:

bash
yamlr demo

Step B: Identify the Failures

Now, point the engine at the demo directory to see it identify the structural failures:

bash
yamlr scan yamlr-demo/

Step C: Deterministic Healing

Once you've reviewed the risks, apply the fixes:

bash
yamlr heal yamlr-demo/

Witness the "Magic":

Visual Diffs: Review exactly what Yamlr proposes to change.
Surgical Mutations: Yamlr fixes the logic while preserving your original comments and formatting.
Atomic Rollback: If you don't like a change, run yamlr rollback to instantly revert the entire session.

🔍 2. Auditing Your Own Infrastructure

Now that you've seen the engine in action, try running a read-only audit on your own Kubernetes manifests.

bash
# Audit a single directory
yamlr scan .

# Audit and fail CI if critical risks are found
yamlr scan . --fail-on error

What's happening during a scan?

Topology Discovery: Yamlr builds a directed acyclic graph (DAG) of your resources.
Cross-Resource Audit: It checks for deep logical failures (e.g., Ingress ports aligning with Container ports).
Risk Classification: Issues are categorized by blast-radius (Traffic, Security, Data, etc.) so you can prioritize your work.

🧭 Next Steps

Explore the full depth of the Yamlr "Wikipedia" reference:

Core Concepts: Deep dive into the ResourceGraph and Risk Classification.
Configuration: Customizing the .yamlr.yaml model for your repository.
CLI Reference: Exhaustive manual for all 30+ functional commands and expert flags.