https://github.com/stefanwalther/helm-utils
Some missing utils not being covered by helm (as node.js library + CLI).
https://github.com/stefanwalther/helm-utils
cli helm helm-charts helm-registry nodejs-library utils
Last synced: 2 months ago
JSON representation
Some missing utils not being covered by helm (as node.js library + CLI).
- Host: GitHub
- URL: https://github.com/stefanwalther/helm-utils
- Owner: stefanwalther
- License: mit
- Created: 2018-10-31T22:39:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-09T18:45:32.000Z (3 months ago)
- Last Synced: 2025-04-12T20:12:01.172Z (2 months ago)
- Topics: cli, helm, helm-charts, helm-registry, nodejs-library, utils
- Language: JavaScript
- Homepage:
- Size: 61.5 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# helm-utils
> Some missing utils when working with helm (as node.js library + CLI).
---
## Purpose
_helm-utils_ provides some complementary utilities for [helm](https://helm.sh), both as CLI-tool and node.js library.
_Note: The author of this library/CLI-tool is everything else than a helm expert. It might be that I have re-implemented something which is anyhow already available in helm. If this is the case, please shoot me a message and raise an [issue](https://github.com/stefanwalther/helm-utils/issues). Thx._
## Install
```bash
$ npm install -g helm-utils
```
## Usage as CLI tool
### get-charts <repo-uri> \[format]
Return all charts from either an online or local chart repository.
This basically does the same as `helm search`, but with some additional sugar functionality.
Example
```bash
$ helm-utils get-charts https://charts.jfrog.io/
```
Options:
- `--format` - How to format the output, `table` or `json`. Defaults to `table`.
### get-images <chart-url> \[format]
Return all docker images from a given helm-chart.
Example
```bash
$ helm-utils get-images https://charts.jfrog.io/artifactory/helm/xray-0.5.2.tgz
```
returns
```bash
Images being used in https://charts.jfrog.io/artifactory/helm/xray-0.5.2.tgz:
(3 images)
- bitnami/mongodb:3.6.4
- postgres
- rabbitmq:3.7-alpine
```
Options:
- `--format` - How to format the output, `list` or `json`. Defaults to `list`.
### help
Example
Show the help for `helm-utils`.
```
$ helm-utils help
```
## Usage as node.js library
See [API docs](./docs/api.md)
## About
### Author
**Stefan Walther**
* [twitter](http://twitter.com/waltherstefan)
* [github.com/stefanwalther](http://github.com/stefanwalther)
* [LinkedIn](https://www.linkedin.com/in/stefanwalther/)
* [stefanwalther.io](http://stefanwalther.io) - Private blog
* [qliksite.io](http://qliksite.io) - Qlik related blog
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/stefanwalther/helm-utils/issues). The process for contributing is outlined below:
1. Create a fork of the project
2. Work on whatever bug or feature you wish
3. Create a pull request (PR)
I cannot guarantee that I will merge all PRs but I will evaluate them all.
### License
MIT
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on November 14, 2018._
[format]: http://samhuri.net/proj/format