@clustercost/cli
v0.1.1
Published
Interactive installer for the ClusterCost agent and dashboard.
Readme
ClusterCost CLI
An interactive, stylish installer that deploys the ClusterCost agent and dashboard into your Kubernetes cluster. It guides you through Helm-based installation, opens a port-forward to the dashboard, and surfaces helpful debug info when needed.
Requirements
- Node.js 18 or later
kubectlconfigured for the target clusterhelmavailable in yourPATH
Usage
npx @clustercost/cliFrom the main menu you can:
- Install the ClusterCost agent and dashboard Helm charts
- Open a
kubectl port-forwardto the dashboard service - Print handy debug information (context, namespaces, Helm status)
Development
npm install # install dependencies
npm run lint # eslint check for all .mjs modules
npm test # vitest unit testsCI runs the same lint + test steps via .github/workflows/ci.yml on every push and pull request.
Publishing
- Ensure you are authenticated with npm (
npm login) and have access to the@clustercostscope. - Bump the
versionfield inpackage.jsonfollowing semver. - Run
npm run lint && npm test(ornpm run releaseto lint, test, and publish in one go). - Publish with
npm publish --access public.
After the publish completes, consumers can install or run directly via npx @clustercost/cli.
Automated publishing
The workflow in .github/workflows/release.yml can publish for you when a GitHub Release is published (or when manually triggered). Configure the NPM_TOKEN repository secret with an npm token that has publish rights to the @clustercost scope before running it.
