[docs] Add Custom process commands docs (withProcessCommand / withProcessCommandFactory)#923
Merged
IEvangelist merged 2 commits intoMay 12, 2026
Conversation
…t APIs Documents the TypeScript (polyglot) process-backed resource command APIs introduced in microsoft/aspire#16972: - withProcessCommand: static process spec registered at AppHost startup - withProcessCommandFactory: dynamic spec built from ExecuteCommandContext arguments at invocation time Adds fundamentals/process-commands.mdx and registers it in the sidebar between Custom HTTP commands and Custom resource URLs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
Move the TypeScript process command factory example into the existing custom resource commands page and remove the duplicate standalone page/navigation entry. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JamesNK
approved these changes
May 12, 2026
|
|
||
| const cache = await builder.addRedis('cache'); | ||
|
|
||
| await cache.withProcessCommandFactory( |
Member
There was a problem hiding this comment.
Out of interest, what are the rules for when to append Factory to the end of the polygot method name?
Contributor
There was a problem hiding this comment.
we have, calback and factory, this just seemed like a better name, but maybe we should call it Callback.
IEvangelist
deleted the
docs/process-command-factory-16972-e6171673d8293861
branch
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
3 participants
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#16972, authored by
@davidfowl.Targeting
release/13.4based on the source PR milestone13.4.Why this PR is needed
microsoft/aspire#16972 added two new TypeScript (polyglot) AppHost APIs for attaching process-backed resource commands to resources:
withProcessCommand– registers a command with a fixed process spec (executable, arguments, environment) at AppHost startup.withProcessCommandFactory(new in #16972) – registers a command whose process spec is built dynamically at invocation time from user-suppliedExecuteCommandContextarguments.Neither API was previously documented on aspire.dev.
What was changed
src/frontend/src/content/docs/fundamentals/process-commands.mdx— a new page covering both APIs, their option types, the C# equivalents, and CLI invocation syntax.src/frontend/config/sidebar/docs.topics.ts— registered the new page in the sidebar between "Custom HTTP commands" and "Custom resource URLs".