Skip to content
CloudGrid Docs

Quickstart

From nothing to a live URL in five commands.

1. Install the CLI

Section titled “1. Install the CLI”
Terminal window
npm install -g @cloudgrid-io/cli

Requires Node.js 18 or later. See Install for Homebrew and the MCP server. Verify:

Terminal window
grid --version

2. Sign in

Section titled “2. Sign in”
Terminal window
grid login

This opens a browser for Google OAuth. Credentials are stored at ~/.cloudgrid/credentials. Confirm who you are:

Terminal window
grid whoami

3. Create an app

Section titled “3. Create an app”
Terminal window
grid new my-app --type static

This scaffolds starter files locally and writes a cloudgrid.yaml. No server entity exists yet — the first grid plug (next step) mints it on the grid and writes the gitignored .cloudgrid/link.json that binds the folder to the entity.

Available templates: node, nextjs, python, static.

4. Plug it in

Section titled “4. Plug it in”
Terminal window
cd my-app
grid plug

grid plug builds a container, deploys it, and prints the live URL:

my-app is live at https://my-app.your-grid.cloudgrid.io

Every subsequent grid plug in the same folder rebuilds and updates the same entity in place. The URL never changes.

5. Open it

Section titled “5. Open it”
Terminal window
grid open

Opens the live URL in your browser. Use grid open --print to print it instead.

Share a single file instead

Section titled “Share a single file instead”

If you just want to share one artifact — an HTML page, a PDF, a deck — point grid plug at the file and it publishes an inspiration:

Terminal window
grid plug ./q2-deck.pdf
q2-deck is live at https://your-grid.cloudgrid.io/q2-deck

Next steps

Section titled “Next steps”