Skip to content

installation.md

Latest commit

 

History

History
78 lines (53 loc) · 1.46 KB

installation.md

File metadata and controls

78 lines (53 loc) · 1.46 KB

Installation

Prerequisites

  • Python 3.10 or later
  • pip 21.0 or greater
  • setuptools 68.0 or greater

Install from PyPI

The recommended way to install the GreenNode CLI is to use pip in a virtualenv:

python -m pip install grncli

or, if you are not installing in a virtualenv, to install globally:

sudo python -m pip install grncli

or for your user:

python -m pip install --user grncli

If you have the grncli package installed and want to upgrade to the latest version:

python -m pip install --upgrade grncli

Install from source

git clone https://github.com/vngcloud/greennode-cli.git
cd greennode-cli
python -m pip install .

To install with development dependencies:

python -m pip install -e ".[dev]"

Bundled installer

On Linux and macOS, the GreenNode CLI can be installed using a standalone installer that creates an isolated virtualenv:

./scripts/install

This installs to ~/.local/lib/GreenNode and symlinks grn to ~/.local/bin/. Make sure ~/.local/bin is in your PATH.

Offline install

For environments without internet access, you can build a self-contained bundle:

# On a machine with internet access
./scripts/make-bundle

# Transfer dist/grncli-bundle.zip to target machine, then:
unzip grncli-bundle.zip
cd grncli-bundle
./install-offline

Verify installation

grn --version
# grn-cli/0.1.0 Python/3.13.5 Darwin/25.2.0