[docs] Document resource-scoped command help and --include-hidden option#904
Merged
davidfowl merged 2 commits intoMay 11, 2026
Merged
Conversation
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
Documents changes from microsoft/aspire#16921: - Add section explaining that 'aspire resource <resource> --help' shows available resource commands discovered from the running AppHost. - Document the '--include-hidden' option for showing and executing hidden resource commands. - Document the '--' delimiter for passing --help to resource commands. - Add AppHost selection section with clearer structure. - Add examples for listing available commands and using --include-hidden. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
davidfowl
force-pushed
the
docs/resource-scoped-command-help-31044f5e2d514d6f
branch
from
9a81ca6 to
64cadbf
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents changes from microsoft/aspire#16921 by
@davidfowl.Targeting
main— falling back tomainbecauserelease/13.4does not exist onmicrosoft/aspire.dev. The source PR milestone is13.4.Why this PR is needed
PR microsoft/aspire#16921 added two significant user-facing CLI improvements:
Resource-scoped help: Running
aspire resource <resource> --helpnow queries the running AppHost and displays an "Available resource commands" section listing all commands that resource exposes. The existing docs stated (correctly at the time) that the CLI didn't expose these commands in--help, which is no longer true.--include-hiddenoption: A new--include-hiddenflag was added to theaspire resourcecommand for both help discovery and command execution. This was not documented at all.--delimiter behavior:--helpafter--is now treated as a resource command argument rather than the CLI help flag.AppHost selection change: Resource-scoped help no longer prompts for AppHost selection when a single in-scope AppHost cannot be determined without
--apphost.Changes
Updated
src/frontend/src/content/docs/reference/cli/commands/aspire-resource.mdx:--delimiter for passing--helpto resource commands--include-hiddento the Options list with description--include-hiddenFiles modified
src/frontend/src/content/docs/reference/cli/commands/aspire-resource.mdx(updated)