https://github.com/bryopsida/node-helm

Node.JS bindings for helm
https://github.com/bryopsida/node-helm

Last synced: 9 days ago
JSON representation

Node.JS bindings for helm

• Host: GitHub
• URL: https://github.com/bryopsida/node-helm
• Owner: bryopsida
• Created: 2023-07-08T22:37:41.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-25T23:48:26.000Z (8 months ago)
• Last Synced: 2024-03-26T00:38:35.600Z (8 months ago)
• Language: TypeScript
• Size: 56.6 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Node-Helm

## Getting Started

This library will automatically download the helm binary for your system when possible and co-locate it on install. If you wish to disable this behavior you can set the environment variable `NODE_HELM_SKIP_DOWNLOAD` to true or disable the script execution using npm's `--ignore-scripts`. However, if you do this you are responsible for providing a compatible helm binary.

If you wish to validate how the binary is downloaded see: [here](https://raw.githubusercontent.com/bryopsida/node-helm/main/scripts/fetchHelmBinary.js)

To install this library run `npm install --save @bryopsida/helm`

In your app,

Start by adding the import

### CommonJS

```javascript

const { Helm } = require('@bryopsida/helm')

```

### ESM

```javascript

import { Helm } from '@bryopsida/helm'

```

### Creating an instance

#### Defaults

```javascript

const helm = new Helm()

```

#### Specify helm binary

```javascript

const helm = new Helm({

    binaryPath: 

})

```

### Listing Helm Releases

```javascript

const releases = await helm.list({

  all: true,

  allNamespaces: true,

})

console.log('==== Helm Releases ====')

releases.forEach((release) => {

  console.log(`Name = ${release.name}`)

  console.log(`Namespace = ${release.namespace}`)

  console.log(`Chart = ${release.chart}`)

  console.log(`Status = ${release.status}`)

})

console.log('==== End Helm Releases ====')

```