kfix Documentation

Opinionated Kubernetes YAML formatter for clean, consistent manifests.

kfix is a command-line tool that formats Kubernetes YAML files with context-aware field ordering and consistent styling. It understands Kubernetes resource structure and applies best-practice formatting rules automatically.

Note

kfix formats valid YAML manifests. It does not fix malformed or syntactically incorrect YAML files. Ensure your YAML is valid before formatting.

Key Features

• K8s-Aware Formatting: Understands Kubernetes resource structure

• Field Ordering: Automatically reorders fields following K8s conventions

• Multi-Document Support: Handles multiple manifests in a single file

• Configurable Indentation: Customize spacing to match your style

• In-Place Editing: Update files directly or output to stdout

• Context-Aware: Nested structures (containers, volumes, etc.) are properly ordered

Quick Start

Install from GitHub releases:

# Download the latest release for your platform
# Visit https://github.com/amaanx86/kfix/releases

# macOS/Linux
sudo mv kfix /usr/local/bin/
chmod +x /usr/local/bin/kfix

Format a manifest:

kfix format deployment.yaml

Format in-place:

kfix format -w deployment.yaml

Documentation Index

Contents:

• Installation
  • Binary Installation (Recommended)
  • Verify Installation
  • Build from Source
  • Building Release Binaries
  • Version Management
  • Creating GitHub Releases
• Usage Guide
  • Basic Usage
  • In-Place Editing
  • Indentation Control
  • Commands Reference
  • Common Workflows
  • Integration with Editors
  • Troubleshooting
  • Examples
• Configuration
  • Field Ordering Rules
  • Indentation Settings
  • Formatting Behavior
  • Limitations
  • Future Configuration

Project Links

• Source Code: https://github.com/amaanx86/kfix

• Releases: https://github.com/amaanx86/kfix/releases

• Issues: https://github.com/amaanx86/kfix/issues