Quick Start

1. Install Foundry

See the Installation page.

2. Initialize a Platform

mkdir my-platform && cd my-platform
foundry init

The init wizard walks you through naming your platform, choosing a template, and defining your initial services. It generates:

• foundry.json — the platform manifest (committed)
• .foundry/runtime.yml — launch config (committed, team-shared)
• .foundry/.gitignore — keeps local state out of VCS

3. Review the Manifest

Open foundry.json. The services block declares your platform topology — each service has a kind, type, and role:

{
  "services": {
    "platform-microlith": {
      "kind": "backend",
      "type": "spring-boot",
      "role": "microlith"
    },
    "hub-frontend": {
      "kind": "frontend",
      "type": "nextjs",
      "role": "hub"
    }
  }
}

4. Configure GitHub Integration

foundry github auth
foundry github discover

Foundry discovers platform repositories by naming convention: the primary repo matches the platform name, satellites match {prefix}-*.

5. Run Your Platform

foundry run

Launches all enabled services using the ports and commands from .foundry/runtime.yml.