[docs] Update aspire agent init output documentation#1087
[docs] Update aspire agent init output documentation#1087aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
Document the improved compact summary output introduced in microsoft/aspire#17519. The command now prints one consolidated message listing all installed skills and locations instead of a separate line per skill. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the aspire agent init CLI reference to document the newer “compact summary” post-install output so users know what successful installation looks like.
Changes:
- Adds a description of the new compact summary output behavior.
- Adds an example of the summary output (skills + locations + completion line).
- Notes behavior for failures and no-op runs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
IEvangelist
left a comment
There was a problem hiding this comment.
Docs accuracy review
Source of truth: microsoft/aspire@cc4b7eaf (release/13.4, fetched 2026-05-29)
PR head: 2431d4634e45a8e637bd77e4f024ca76e02f0837
| Verdict | Count |
|---|---|
| verified | 4 |
| verified-with-nuance | 0 |
| unverifiable | 0 |
| contradicted | 0 |
Verdict: APPROVE — every claim in the diff matches the implementation at release/13.4.
Doc-tester (UX) notes
I treated the new code-block as something a user would compare against their terminal after running aspire agent init. The reproduction is faithful: the emoji glyphs, header text, label format, and ✅-line all match the strings shipped in the CLI resources, and the visible 5-column indent in the doc accurately reflects what Spectre.Console renders when a multi-line message is paired with an emoji prefix.
Verified claims (with evidence)
| # | Claim | Evidence |
|---|---|---|
| 1 | "When one or more skills are installed, the command prints a single compact summary instead of a separate message per skill." | src/Aspire.Cli/Commands/AgentInitCommand.cs:364 calls DisplayInstalledSkillsSummary(installedSkills) once after the per-skill install loop. The summary helper (:496-511) emits exactly one DisplayMessage(KnownEmojis.Robot, message). Per-skill installs in InstallSkillAsync (:442-494) only append a summary item; they don't emit a message of their own on success. |
| 2 | Exact output: 🤖 Installed Aspire agent skills:, Skills: aspire, aspireify, aspire-deployment, Locations: .agents/skills, ~/.agents/skills, ✅ Agent environment configuration complete. |
Strings come from AgentCommandStrings.resx:111-118 ("Installed Aspire agent skills:", "Skills: {0}", "Locations: {0}") and McpCommandStrings.resx:84-86 ("Agent environment configuration complete."). Emojis: KnownEmojis.Robot (KnownEmojis.cs:49) → 🤖, KnownEmojis.CheckMarkButton (:33) → ✅ via DisplaySuccess (ConsoleInteractionService.cs:572-575). The 5-column visual indent in the doc reflects the Spectre Grid layout in WriteEmojiMessage (ConsoleInteractionService.cs:459-485), which puts the emoji in a fixed first column so the message body's " " indent (AgentInitCommand.cs:507-508) visually aligns under "Installed". |
| 3 | "If a skill install fails, the error message includes the exact skill path that failed." | AgentInitCommand.cs:451 builds fullSkillDirectoryPath = Path.Combine(rootDirectory.FullName, relativeSkillPath). The catch at :488-493 calls DisplayError(string.Format(InitCommand_FailedToInstallSkill, skill.Name, fullSkillDirectoryPath, ex.Message)). The resource format "Failed to install {0} skill at {1}: {2}" (AgentCommandStrings.resx:120-122) substitutes the full path as {1}. |
| 4 | "No-op runs ... stay quiet and print only the final completion message." | InstallSkillAsync skips re-writing a file when its existing content already matches (:467-473) and returns (Succeeded: true, UpdatedSkill: null) when no file was updated (:480-483). The aggregate installedSkills therefore stays empty, and DisplayInstalledSkillsSummary short-circuits at :498-501 (if (installedSkills.Count == 0) return). The only remaining output on the success path is DisplaySuccess(McpCommandStrings.InitCommand_ConfigurationComplete) at :429. |
- Clarify installed skill summary examples and available skill-file outputs (PRRT_kwDOQK_VN86E_zkv) - Reword no-op output behavior to avoid quiet ambiguity (PRRT_kwDOQK_VN86E_zk0) Verified against microsoft/aspire@11bea2e on branch release/13.4. Edited per the doc-writer skill. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Documents changes from microsoft/aspire#17519 by
@IEvangelist.Targeting
release/13.4— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.5(from the source PR milestone13.5) does not exist there.Why this PR is needed
microsoft/aspire#17519 changed
aspire agent initto print a single compact summary of installed skills and locations instead of a separate success message for every skill at every install target. Theaspire-agent-initreference page did not describe what the command prints after installation, leaving users without a clear picture of what success looks like.What changed
Updated
src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdxto:Files modified
src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx— updated existing page