Handbook - Getting started

Getting Started

Run CloudGrid locally, send telemetry, and verify the repository.

On this page
On this page

Start here when you want a working CloudGrid stack on your machine. Use release Compose when you want to evaluate the product from published images. Use the source quickstart when you are changing CloudGrid itself.

If you use an AI coding assistant, install the CloudGrid skills first so setup, operations, and extension work starts from the project specs and checked-in playbooks.

Path

diagram
Evaluate product Change code Install AI skills What are you doing? Run release Compose Run source quickstart Send telemetry Open project workspaces Run focused checks
Mermaid diagram rendered with beautiful-mermaid.

Pages

StepPageOutcome
1Install AI skillsGive compatible AI assistants the CloudGrid skill catalog.
2Run the release Compose stackRun CloudGrid from published images.
3Local quickstartRun CloudGrid from source and open the UI.
4Send telemetryPush traces, logs, and metrics through OTLP HTTP or gRPC.
5Verify the repositoryChoose the right local check before committing.

Minimal Commands

Source development:

bun install
bun run setup:local
bun run dev:infra
bun run dev:all

Then open the frontend at http://127.0.0.1:5173/.

Release images:

cd deploy/compose
./cloudgrid-local.sh up

Then open CloudGrid at http://localhost:3000/.

Last updated .