dotnet / dotnet/command-line-api

[Feature Request] Invocation examples

Open
#1,827 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
C#
Stars
3.7k
Forks
428
PR merge metrics
No merged PRs in 30d

Description

Please add examples to the help text, per command.

As done for [Spectre.Console](https://spectreconsole.net/cli/commands#configuring). (Examples are optional; they are specified in code, they aren't created dynamically.)

e.g. `myapp foo --help` will also print this:
````
EXAMPLES:
myapp foo
myapp foo -f somefile.txt
myapp foo --file somefile.txt
````

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.