Skip to content

GreenNode CLI

Universal Command Line Interface for GreenNode.

The GreenNode CLI (grn) is a unified tool to manage your GreenNode services from the command line. Written in Go, distributed as a single binary with zero dependencies.

Quick Start

# Download binary (macOS Apple Silicon example)
curl -L -o grn https://github.com/vngcloud/greennode-cli/releases/latest/download/grn-darwin-arm64
chmod +x grn
sudo mv grn /usr/local/bin/

# Configure credentials
grn configure

# List your VKS clusters
grn vks list-clusters

# Get cluster details
grn vks get-cluster --cluster-id <id>

Features

  • Single Binary — Zero dependencies, download and run
  • VKS Management — Full cluster and node group lifecycle (create, get, update, delete)
  • Multiple Output Formats — JSON, table, and text with JMESPath query filtering
  • Auto-pagination — List commands fetch all pages by default
  • Dry-run — Validate parameters before create/update/delete
  • Delete Confirmation — Preview and confirm before destructive operations
  • Waiter Commands — Wait for async operations to complete
  • Profile Support — Multiple credential profiles for different environments
  • Retry with Backoff — Automatic retry for transient errors (5xx, timeouts)
  • Security — Credentials masked in output, input validation, SSL by default
  • Cross-platform — Linux, macOS, Windows (amd64, arm64)

Adding New Services

Other product teams can add CLI commands for their service. See Contributing for details.