Skip to content

update docs with handler attribute rename #57

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.

Sign up for GitHub

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
dotnetKyle merged 1 commit into from
Oct 28, 2025
Merged

update docs with handler attribute rename #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
>
> The primary goal of this library is to give a developer the power to get started with
> System.CommandLine and to create commands with minimal boilerplate. All you have to do
> to turn a function into a command is decorate it with the `[Command]` attribute!
> to turn a function into a command is decorate it with the `[Handler]` attribute!

## Getting Started

Expand All @@ -22,7 +22,7 @@ using System.CommandLine.Minimal;
public class HelloWorld
{
// Just decorate the method with the command attribute!
[Command("hello")]
[Handler("hello")]
public void Execute(string message)
{
Console.WriteLine("Hello World! {0}", message);
Expand Down Expand Up @@ -74,7 +74,7 @@ using System.CommandLine.Minimal;

public class MyCommand
{
[Command("mycommand")]
[Handler("mycommand")]
public void Run(string myArgument, string? myOption = null)
{
Console.WriteLine("Arg:{0}, Option:{0}", myArgument, myOption);
Expand Down Expand Up @@ -105,7 +105,7 @@ using System.CommandLine.Minimal;

public class MyCommand
{
[Command("mycommand")]
[Handler("mycommand")]
public void Execute(string myArgument, [Argument] string? myArgument2 = null)
{
Console.WriteLine("Arg:{0}, Arg2:{0}", myArgument, myArgument2);
Expand Down Expand Up @@ -165,7 +165,7 @@ public class GreeterCommand
_myInjectedClass = myInjectedClass;
}

[Command("greet")]
[Handler("greet")]
public async Task ExecuteAsync(string name, string? tone = null)
{
// ... use _myInjectedClass here
Expand All @@ -179,7 +179,7 @@ or
// a static class command
public static class GreeterCommand
{
[Command("greet")]
[Handler("greet")]
public static async Task ExecuteAsync(
string name,
[FromServices] MyInjectedClass myInjectedClass,
Expand Down
Loading