Skip to content

API Reference

Use the API reference after you have chosen a package and workflow. The generated pages list public types, properties, and methods from source so the reference can be refreshed as the SDK changes.

Start with the package guide

PackageCurated guideGenerated reference
HelmSharp.ActionPackage guideAPI
HelmSharp.ChartPackage guideAPI
HelmSharp.EnginePackage guideAPI
HelmSharp.KubePackage guideAPI
HelmSharp.ReleasePackage guideAPI
HelmSharp.RepoPackage guideAPI
HelmSharp.RegistryPackage guideAPI
HelmSharp.StoragePackage guideAPI
HelmSharp.PostRendererPackage guideAPI

Reading generated pages

Generated pages intentionally stay factual: type kind, source file, properties, methods, and a short usage note. They do not replace the guide pages because raw member lists cannot explain workflow boundaries.

Template function APIs

Types under HelmSharp.Engine.Functions and HelmSharp.Engine.Utilities are documented as part of the engine reference, but they primarily support Helm/Sprig template execution. Application code should normally call HelmTemplateRenderer, not those helper functions directly.

Regenerating

powershell
pwsh docs/scripts/generate-api-reference.ps1

Released under the MIT License.