addSquad

Method

📦 CommunityToolkit.Aspire.Hosting.Squad v13.5.0

interface IDistributedApplicationBuilder {
  // ... omitted for brevity
  addSquad(
      name: string,
      teamRoot?: string): SquadResource;
}

Signature

methodaddSquadbuilder

Adds a Squad AI-agent team to the distributed application. The lifecycle hook discovers agents from `.squad/team.md` (or the default roster when the file does not exist), publishes `Spawning` to `Active` state transitions visible in the Aspire dashboard, and injects a custom `squad://` descriptor that downstream services can consume as metadata. The Squad resource is a logical dashboard/resource-graph entry; it does not start a server process by itself.

addSquad(
    name: string,
    teamRoot?: string): SquadResource

Parameters

namestring

teamRootstringoptional

Returns

SquadResource

Applies to

This method applies to the following types:

typeIDistributedApplicationBuilder