Nyl

Kubernetes manifest generator with Helm integration

Fast, efficient Kubernetes manifest generation with a small operational footprint.

✨ Features

• 🚀 Blazing Fast: Optimized manifest generation
• 📦 Simple Distribution: Single-binary CLI install flow
• 🧩 Component-Oriented: Local component charts, aliases, and remote chart shortcuts
• 🔧 Helm Integration: First-class Helm chart support with value customization
• 🌍 Multi-Environment: Profile-based configurations (dev, staging, prod)
• 🔐 Git Support: Private repository access with SSH/HTTPS authentication
• 🎨 Templating: Jinja2-compatible templates with custom filters
• ☸️ Kubernetes Native: kubectl-style diff and apply commands

📥 Installation

From Release (Recommended)

# Download latest release for your platform
# Linux (x86_64)
curl -LO https://github.com/NiklasRosenstein/nyl/releases/latest/download/nyl-x86_64-unknown-linux-gnu.tar.gz
tar xzf nyl-x86_64-unknown-linux-gnu.tar.gz
sudo mv nyl /usr/local/bin/

# macOS (Apple Silicon)
curl -LO https://github.com/NiklasRosenstein/nyl/releases/latest/download/nyl-aarch64-apple-darwin.tar.gz
tar xzf nyl-aarch64-apple-darwin.tar.gz
sudo mv nyl /usr/local/bin/

# macOS (Intel)
curl -LO https://github.com/NiklasRosenstein/nyl/releases/latest/download/nyl-x86_64-apple-darwin.tar.gz
tar xzf nyl-x86_64-apple-darwin.tar.gz
sudo mv nyl /usr/local/bin/

From Source

# Clone repository
git clone https://github.com/NiklasRosenstein/nyl.git
cd nyl/nyl

# Build and install
cargo install --path .

# Or just build
cargo build --release
# Binary will be at target/release/nyl

Using Cargo

cargo install --git https://github.com/NiklasRosenstein/nyl nyl

🚀 Quick Start

# Create a new project
nyl new project my-app
cd my-app

# Validate configuration
nyl validate

# Render manifests for development
nyl render --profile dev

# See diff against cluster
nyl diff --profile dev

# Apply to cluster
nyl apply --profile dev

📚 Commands

📖 Documentation

Comprehensive documentation is available in mdbook format:

# Serve documentation locally
mdbook serve book --open

# Or view online
# https://niklasrosenstein.github.io/nyl/

Documentation includes:

• Getting started guide
• Component system guide
• Configuration reference
• Command documentation
• API reference (rustdoc)
• Example projects

Key entry points:

• Component System
• Component Reference

🎯 Examples

Check out the examples/ directory for practical usage:

• simple-app - Basic web application with profiles
• More examples coming soon!

🏗️ Architecture

src/
├── cli/          # Command-line interface with clap
│   ├── commands/ # Command implementations (render, diff, apply, etc.)
│   └── output/   # Output formatting with colored diffs
├── config/       # Project configuration loading
├── template/     # MiniJinja templating engine
├── generator/    # Manifest generation pipeline
├── kubernetes/   # Kubernetes client integration (kube-rs)
├── resources/    # HelmChart, Component resources
├── git/          # Git repository management with authentication
├── helm/         # Helm chart processing
├── components/   # Component discovery and registry
├── profiles/     # Profile management
├── secrets/      # Secrets provider framework
└── util/         # Utilities (fs, hashing, etc.)

⚙️ Development

Prerequisites

• Rust 1.83 or newer
• kubectl (for diff/apply commands)
• Helm (for Helm chart rendering)

Building

# Development build
cargo build

# Release build (optimized)
cargo build --release

# Run tests
cargo test

# Format and lint
cargo fmt
cargo clippy -- -D warnings

Using mise

The project includes a .mise.toml for tool management:

# Install tools
mise install

# Run tasks
mise run fmt          # Format code
mise run lint         # Run clippy
mise run test         # Run tests
mise run docs-serve   # Serve documentation

🧪 Testing

# Run all tests
cargo test

# Run with coverage
cargo tarpaulin --out Html

# Test specific module
cargo test --lib config::tests

# Integration tests
cargo test --test integration_test

Test Coverage:

• 221 unit tests
• 34 integration tests
• 90%+ code coverage

🗺️ Roadmap

✅ Completed (v0.1.0)

• Configuration & CLI foundation
• Template engine (Jinja2-compatible)
• Helm integration
• Component system
• Git repository support with authentication
• Kubernetes client integration
• Diff & apply commands
• ArgoCD integration

🔮 Future Releases

• v0.2.0: SOPS secrets integration
• v0.3.0: SSH tunnel & profile enhancements
• v0.4.0: Advanced post-processing
• v0.5.0: Performance optimizations & caching improvements

📄 License

MIT License - see LICENSE for details

🙏 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines.

Contributors

• Niklas Rosenstein (@NiklasRosenstein)

📝 Changelog

See CHANGELOG.md for a detailed history of changes.

🔗 Links

• Repository
• Issues
• Releases
• Documentation

Made with ❤️ in Rust