Skip to content

System.CommandLine docs update #46594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 25 commits into from
Jun 19, 2025
Merged

System.CommandLine docs update #46594

merged 25 commits into from
Jun 19, 2025

Conversation

adamsitnik
Copy link
Member

@adamsitnik adamsitnik commented Jun 6, 2025

High level overview:

  1. I've merged the doc that explains the syntax (https://learn.microsoft.com/en-us/dotnet/standard/commandline/syntax) without showing the code and the doc that shows the related code (https://learn.microsoft.com/en-us/dotnet/standard/commandline/define-commands) into one.
  2. I've moved the "Command-line design guidance" from syntax doc to a dedicated doc (it's big and important, but the very new users don't need to ready it when learning about syntax for the first time).
  3. I've introduced a dedicated doc about how to parse and invoke to show it's two separate things.
  4. I've introduced dedicated doc about other features such as parsing and validation etc
  5. I've simplified the tutorial to start with a code that does not use invoking at all, just to show all its benefits and gradually use more features.

Internal previews

Toggle expand/collapse
📄 File 🔗 Preview link
docs/fundamentals/toc.yml docs/fundamentals/toc
docs/standard/commandline/design-guidance.md Design guidance
docs/standard/commandline/get-started-tutorial.md Tutorial: Get started with System.CommandLine
docs/standard/commandline/how-to-configure-the-parser.md How to configure the parser in System.CommandLine
docs/standard/commandline/how-to-customize-help.md Customize help output
docs/standard/commandline/how-to-customize-parsing-and-validation.md docs/standard/commandline/how-to-customize-parsing-and-validation
docs/standard/commandline/how-to-enable-tab-completion.md Tab completion for System.CommandLine
docs/standard/commandline/how-to-parse-and-invoke.md "How to parse and invoke the result"
docs/standard/commandline/index.md System.CommandLine overview
docs/standard/commandline/migration-guide-2.0.0-beta5.md docs/standard/commandline/migration-guide-2.0.0-beta5
docs/standard/commandline/syntax.md Syntax overview: Commands, options, and arguments

@adamsitnik adamsitnik requested review from tdykstra and a team as code owners June 6, 2025 19:01
@dotnetrepoman dotnetrepoman bot added this to the June 2025 milestone Jun 6, 2025
@adamsitnik adamsitnik requested a review from gewarren June 16, 2025 21:05
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding all these docs!

Copy link
Contributor

@adegeo adegeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's really awesome to see some traction in this area, thanks you! Here are some improvements I found.

@adamsitnik adamsitnik closed this Jun 19, 2025
@adamsitnik adamsitnik reopened this Jun 19, 2025
@adamsitnik adamsitnik closed this Jun 19, 2025
@adamsitnik adamsitnik reopened this Jun 19, 2025
@adamsitnik adamsitnik merged commit 178be2d into dotnet:main Jun 19, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants