Skip to content

Quickstart

The fastest way to get started is using our CLI. It handles installing the agent and the local dashboard in your Kubernetes cluster.

  1. Run the installer

    Open your terminal and run:

    Terminal window
    npx @clustercost/cli
  2. Select your cluster

    The CLI will detect your current Kubernetes context. Press Enter to confirm installation.

    β—‡ We detected Kubernetes context: arn:aws:eks:us-east-1:123...
    Install ClusterCost here?
    β”‚ Yes
  3. Wait for deployment

    The tool will install the Agent (metrics collector) and Dashboard (UI) into the clustercost namespace.

    βœ” Helm repositories updated
    βœ” ClusterCost agent deployed
    βœ” ClusterCost dashboard deployed
  4. Launch the Dashboard

    Once installed, select β€œLaunch dashboard” from the menu. The CLI will automatically set up a secure port-forward.

    β—‡ What would you like to do?
    β”‚ Launch dashboard (port-forward)
    βœ” Dashboard tunnel established
    Dashboard available at http://localhost:3000
  5. Explore your costs

    Open http://localhost:3000 in your browser.