The GreenNode CLI (grn) is a unified tool to manage your GreenNode services from the command line.
- Python 3.10 or later (3.10.x, 3.11.x, 3.12.x, 3.13.x)
The safest way to install the GreenNode CLI is to use pip in a virtualenv:
python -m pip install grnclior, if you are not installing in a virtualenv, to install globally:
sudo python -m pip install grnclior for your user:
python -m pip install --user grncliIf you have the grncli package installed and want to upgrade to the latest version:
python -m pip install --upgrade grncliOn Linux and macOS, the GreenNode CLI can also be installed using a bundled installer. For offline environments, see the offline install guide.
If you want to run the develop branch of the GreenNode CLI, see the Contributing Guide.
Before using the GreenNode CLI, you need to configure your credentials. The quickest way is to run:
grn configureGRN Client ID [None]: <your-client-id>
GRN Client Secret [None]: <your-client-secret>
Default region name [HCM-3]:
Default output format [json]:
Credentials are obtained from the VNG Cloud IAM Portal under Service Accounts.
You can also configure the region via environment variable:
export GRN_DEFAULT_REGION=HCM-3Or create the credential files directly:
# ~/.greenode/credentials
[default]
client_id = your-client-id
client_secret = your-client-secret# ~/.greenode/config
[default]
region = HCM-3
output = jsonTo use multiple profiles:
grn configure --profile staging
grn --profile staging vks list-clustersFor more configuration options, see the Configuration Guide.
The GreenNode CLI uses a multi-part command structure:
grn <service> <command> [options and parameters]For example, to list your VKS clusters:
grn vks list-clustersTo get help on any command:
grn help
grn vks
grn vks create-cluster helpTo check the version:
grn --versionThe best way to interact with our team is through GitHub:
- Open an issue — Bug reports and feature requests
- Search existing issues before opening a new one
Apache License 2.0 — see LICENSE.