aspire init command

Name

aspire init - Initialize Aspire support in an existing codebase with a C# or TypeScript AppHost.

Synopsis

Aspire CLI

aspire init [options]

Description

The aspire init command initializes Aspire support in an existing repo or workspace. It scaffolds a minimal AppHost skeleton together with an aspire.config.json, then optionally installs the aspireify agent skill so your AI coding agent can complete the wiring.

This command defaults to interactive mode. When executed without any options, the command prompts you for the AppHost language when more than one path is available.

टिप्पणी

The --source and --version options are deprecated and no longer affect aspire init. They are accepted for backward compatibility but will be removed in a future release.

AppHost detection

The command adapts to the repo it finds:

• C# file-based AppHost (when selected interactively) — creates apphost.cs with #:sdk and #:package directives for a lightweight single-file orchestrator.
• TypeScript AppHost (when selected interactively) — creates apphost.ts with the generated .modules/ folder.

Note

When a .sln or .slnx is present, the C# option creates a project-based AppHost instead — an AppHost.csproj added to the solution with ProjectReference items and strongly-typed AddProject<T>() calls.

In all cases, the AppHost language does not limit what you can orchestrate — C#, JavaScript, Python, Go, Rust, Java, containers, and more can all be modeled in the same application model.

The aspireify skill

After the skeleton is dropped, aspire init has an option to install the aspireify skill into your AI agent’s skill directory (the same directory used by aspire agent init). The skill is a Markdown file with instructions that guide your AI coding agent through completing the Aspire wiring for your specific codebase.

The skill instructs the agent to:

• Scan the repo and discovering existing projects, services, and containers
• Ask you clarifying questions before making decisions — for example, which services to orchestrate, whether a hardcoded port is significant, or whether to map an existing env var or switch to Aspire’s service discovery
• Wire resources into the AppHost with WithReference, WaitFor, endpoints, and volumes
• Optionally configure OpenTelemetry
• Validate the wiring with a smoke-test aspire start

Options

The following options are available:

• --channel

  Channel to use for templates (stable, staging, daily).

• --language

  The AppHost language to scaffold (csharp, typescript).

• -?, -h, --help

  Prints help and usage documentation for the available commands and options.

• -l, --log-level <Critical|Debug|Error|Information|None|Trace|Warning>

  Set the minimum log level for console output. Use this option to increase diagnostics while troubleshooting or reduce output in scripted runs.

• --non-interactive

  Run the command in non-interactive mode, disabling all interactive prompts and spinners.

• --nologo

  Suppress the startup banner and telemetry notice.

• --banner

  Display the animated Aspire CLI welcome banner.

• --wait-for-debugger

  Wait for a debugger to attach before running a command.

Examples

• Initialize Aspire support in the current repo interactively:

  Aspire CLI

  aspire init

• Initialize Aspire support with a TypeScript AppHost:

  Aspire CLI

  aspire init --language typescript

• Initialize Aspire support using the daily channel templates:

  Aspire CLI

  aspire init --channel daily