Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

AddSquad

Method
📦 CommunityToolkit.Aspire.Hosting.Squad v13.6.1
func (DistributedApplicationBuilder) AddSquad(
name string,
options ...*AddSquadOptions,
) 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,
options ...*AddSquadOptions,
) SquadResource
namestringThe Aspire resource name.
options...*AddSquadOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*AddSquadOptions argument.

TeamRoot*stringAbsolute path to the workspace root - the directory that contains the .squad/ folder. Defaults to GetCurrentDirectory when not specified.
SquadResource

An IResourceBuilder for further configuration.

Returns a handle; failures surface later via Err().

Applies to

This method applies to the following types:

typeDistributedApplicationBuilder