Getting Started

This guide gets you from an empty GitOps source project to rendered Kubernetes manifests, then points you at the workflow that matches how you deploy.

Installation

With mise

Add Nyl to your mise.toml:

[tools."github:NiklasRosenstein/nyl"]
version = "0.4.1"
version_prefix = "v"

Then install it:

mise install

From Release

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/

From Source

cd nyl
cargo build --release

The binary will be available at nyl/target/release/nyl when building from the repository root.

Install Locally

cd nyl
cargo install --path .

This installs nyl to ~/.cargo/bin/nyl.

Quick Start

1. Create a Project

nyl new project platform
cd platform

This creates:

• nyl.toml - Project configuration
• components/ - Directory for components

2. Add a Component

nyl new component v1.example.io MyApp

This creates a new local component at components/v1.example.io/MyApp/ with:

• Chart.yaml - Helm chart metadata
• values.yaml - Default values
• values.schema.json - JSON schema for validation
• templates/deployment.yaml - Kubernetes deployment template

3. Validate

nyl validate

Output:

✓ Found project config: /path/to/platform/nyl.toml
✓ Components search path exists: /path/to/platform/components
✓ Helm chart search path exists: /path/to/platform

✓ Validation passed

For CI, use strict mode to treat warnings as errors:

nyl validate --strict

4. Render

Render a manifest file to stdout:

nyl render apps.yaml

For deterministic CI rendering without cluster discovery, use offline mode. If your nyl.toml defines [project.kubernetes] or [profile.<name>.kubernetes], Nyl uses those values automatically:

nyl render --offline -p dev apps.yaml

Project Structure

platform/
├── nyl.toml                  # Project configuration
├── components/               # Component definitions
│   └── v1.example.io/
│       └── MyApp/
│           ├── Chart.yaml
│           ├── values.yaml
│           ├── values.schema.json
│           └── templates/
│               └── deployment.yaml
└── charts/                   # Optional: additional Helm chart search path

Next Steps

• Use rendered manifest GitOps when CI should produce plain YAML for ArgoCD, Flux, or another reconciler.
• Use CLI-first workflows for debugging, bootstrapping, testing, and direct cluster operations.
• Use ArgoCD CMP integration when ArgoCD should render Nyl inputs directly.
• Read about Configuration and the Component System.