CloudGrid Documentation
Everything you need to plug, run, and scale apps on CloudGrid. These pages are generated directly from the CloudGrid Developer Guide, so they always match the latest release.
Orientation
- What is CloudGridCloudGrid is an internal runtime for AI-built work. It runs on GKE and lets anyone on a team — marketer, PM, engineer, A
- Key ConceptsEntity. The universal unit. Every inspiration, app, and agent is an Entity with a different realm and kind.
- Install and AuthenticateThe CLI verb is grid (the old cloudgrid, gridctl, and cg names are deprecated).
Workflows
- Workflow A: Deploy Existing CodeYou already have a project. You want to put it on the grid.
- Workflow B: Start a New ProjectYou want to start from scratch with scaffolded files.
- Workflow C: Share a File or ArtifactYou have an HTML file, PDF, deck, or Claude artifact and want to share it with your team.
- Workflow D: Graduate a Drop to an AppAn inspiration can graduate to a full app without changing its URL or losing history.
- Framework ExamplesScaffolded structure:
- Multi-Service AppsA single entity can contain multiple services — for example, an API backend and a frontend.
Day-to-Day Operations
- Local DevelopmentThis:
- Environment Variables and SecretsThese are set automatically based on your cloudgrid.yaml. You cannot override them:
- Logs, Status, and DebuggingThis acquires a service account token and fires an HTTP request with the X-CloudGrid-Caller-Token header.
- Deploys, Rollbacks, and VersionsRollback re-points at an existing built image. Environment variables and secrets are unchanged.
- Custom Domains and VisibilityAdd custom domains in cloudgrid.yaml:
Shared Infrastructure
- Database (MongoDB)The platform injects MONGODBURL at runtime. In your code:
- RedisThe platform injects REDISURL. In your code:
- AI GatewayCloudGrid provides a built-in AI gateway that routes to Claude models with automatic metering, budgeting, and identity m
- File PersistenceBy default, deployed containers have ephemeral storage. To persist files across deploys and restarts:
Collaboration and Sharing
- Organizations and SpacesEvery entity belongs to an org. Users can belong to multiple orgs.
- Team ManagementRoles:
- Sharing and Visibility Modes1. Set visibility to link for public sharing
- Forking and CloningFork creates a new entity in your org with permanent lineage back to the source. The source and fork are independent fro
Automation and Integration
- GitHub Auto-DeployWire a GitHub repository to your entity for automatic deployment on push.
- Webhooks and ConnectorsConnectors integrate CloudGrid with external services. Configure them declaratively in cloudgrid.yaml.
- MCP IntegrationCloudGrid provides MCP (Model Context Protocol) servers for AI tool integration. This lets AI assistants (Claude, etc.)
- Inter-App CommunicationEntities on the grid can call each other using the caller/callee model.
- AgentsAn agent is an app with an agent: block. Same entity, same deploy path, same console.