Grid CLI Overview

Introduction

Grid gives you multiple ways to interact with and configure your Grid deployments. With the command-line interface (CLI) you can interact with the Grid platform using a terminal, or through an automated system, enabling you to:

• Deploy applications directly from your local environment
• Manage your deployments and configurations
• Automate deployment workflows
• Access logs and monitor your applications

Installing Grid CLI

To download and install Grid CLI, run the following command:

npm install -g cli-grid

This will install the Grid CLI globally on your system, making it available from any terminal.

Updating Grid CLI

When there is a new release of Grid CLI, running any command will show you a message letting you know that an update is available.

If you have installed our command-line interface through npm, Yarn, or pnpm, the easiest way to update it is by running the installation command yet again:

npm install -g cli-grid

Checking the version

The --version option can be used to verify the version of Grid CLI currently being used:

grid --version

Using the grid command with the --version option.

Checking available commands

The help option can be used to verify available commands:

grid help

Using the grid command with the help option.

Using in a CI/CD environment

Grid CLI requires you to log in and authenticate before accessing resources or performing administrative tasks. In a terminal environment, you can use grid login google/github

Available Commands