CLI overview

The CloudGrid CLI ships as the npm package @cloudgrid-io/cli and installs a single command: grid. It covers the full create-deploy-manage cycle.

npm install -g @cloudgrid-io/cli
grid --version

Requires Node.js 18 or later. See Install for Homebrew.

Quick start

grid login              # sign in via Google OAuth
grid new my-app         # scaffold an app
grid plug               # build, deploy, go live

Command groups

Group	Commands
Core lifecycle	new, plug, unplug, status, dev
Monitoring	follow, logs, open, info, versions, rollback, ssh
Collaboration	pickup, fork, remix, download, link, rename
Env and secrets	env, secrets
Visibility	visibility
Resource management	get, create, describe, delete
Wiring	wire
Scaffolding	scaffold, agent
Spaces	space
Admin and team	admin, admin brain, admin telemetry
Webhooks	hooks
Authentication	login, logout, whoami, use
Utilities	version, doctor, feedback, completion
Debug	debug call, debug ssh

Global options

These work on all commands:

Option	Description
-v, --verbose	Show detailed output.
-o, --output <format>	Output format: json, yaml, table, csv.
--json	Alias for -o json (on commands that support it).
--grid <slug>	Override the active grid for this command.
-V, --version	Print the CLI version.
-h, --help	Show help for a command.

Entity resolution

When a command targets an entity, the CLI resolves it in this order:

1. No argument, inside a linked directory — reads .cloudgrid/link.json (which holds the entity id).
2. A UUID — globally addressable and unambiguous.
3. org/slug — globally addressable.
4. A bare slug — searched across all your grid memberships. If the slug matches entities in multiple grids the CLI errors; disambiguate with org/slug.

The --grid <slug> flag scopes resolution to a specific grid.