github.com/stefanmcshane/helm@v0.0.0-20221213002717-88a4a2c6e77d/README.md (about)

     1  # Helm
     2  
     3  [![CircleCI](https://circleci.com/gh/helm/helm.svg?style=shield)](https://circleci.com/gh/helm/helm)
     4  [![Go Report Card](https://goreportcard.com/badge/github.com/helm/helm)](https://goreportcard.com/report/github.com/helm/helm)
     5  [![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/helm.sh/helm/v3)
     6  [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3131/badge)](https://bestpractices.coreinfrastructure.org/projects/3131)
     7  
     8  Helm is a tool for managing Charts. Charts are packages of pre-configured Kubernetes resources.
     9  
    10  Use Helm to:
    11  
    12  - Find and use [popular software packaged as Helm Charts](https://artifacthub.io/packages/search?kind=0) to run in Kubernetes
    13  - Share your own applications as Helm Charts
    14  - Create reproducible builds of your Kubernetes applications
    15  - Intelligently manage your Kubernetes manifest files
    16  - Manage releases of Helm packages
    17  
    18  ## Helm in a Handbasket
    19  
    20  Helm is a tool that streamlines installing and managing Kubernetes applications.
    21  Think of it like apt/yum/homebrew for Kubernetes.
    22  
    23  - Helm renders your templates and communicates with the Kubernetes API
    24  - Helm runs on your laptop, CI/CD, or wherever you want it to run.
    25  - Charts are Helm packages that contain at least two things:
    26    - A description of the package (`Chart.yaml`)
    27    - One or more templates, which contain Kubernetes manifest files
    28  - Charts can be stored on disk, or fetched from remote chart repositories
    29    (like Debian or RedHat packages)
    30  
    31  ## Install
    32  
    33  
    34  Binary downloads of the Helm client can be found on [the Releases page](https://github.com/helm/helm/releases/latest).
    35  
    36  Unpack the `helm` binary and add it to your PATH and you are good to go!
    37  
    38  If you want to use a package manager:
    39  
    40  - [Homebrew](https://brew.sh/) users can use `brew install helm`.
    41  - [Chocolatey](https://chocolatey.org/) users can use `choco install kubernetes-helm`.
    42  - [Scoop](https://scoop.sh/) users can use `scoop install helm`.
    43  - [GoFish](https://gofi.sh/) users can use `gofish install helm`.
    44  - [Snapcraft](https://snapcraft.io/) users can use `snap install helm --classic`
    45  
    46  To rapidly get Helm up and running, start with the [Quick Start Guide](https://helm.sh/docs/intro/quickstart/).
    47  
    48  See the [installation guide](https://helm.sh/docs/intro/install/) for more options,
    49  including installing pre-releases.
    50  
    51  ## Docs
    52  
    53  Get started with the [Quick Start guide](https://helm.sh/docs/intro/quickstart/) or plunge into the [complete documentation](https://helm.sh/docs)
    54  
    55  ## Roadmap
    56  
    57  The [Helm roadmap uses GitHub milestones](https://github.com/helm/helm/milestones) to track the progress of the project.
    58  
    59  ## Community, discussion, contribution, and support
    60  
    61  You can reach the Helm community and developers via the following channels:
    62  
    63  - [Kubernetes Slack](https://kubernetes.slack.com):
    64    - [#helm-users](https://kubernetes.slack.com/messages/helm-users)
    65    - [#helm-dev](https://kubernetes.slack.com/messages/helm-dev)
    66    - [#charts](https://kubernetes.slack.com/messages/charts)
    67  - Mailing List:
    68    - [Helm Mailing List](https://lists.cncf.io/g/cncf-helm)
    69  - Developer Call: Thursdays at 9:30-10:00 Pacific ([meeting details](https://github.com/helm/community/blob/master/communication.md#meetings))
    70  
    71  ### Code of conduct
    72  
    73  Participation in the Helm community is governed by the [Code of Conduct](code-of-conduct.md).