如何让System.CommandLine忽略未识别的命令行参数

要解决未定义选项报错的问题，有两种简单可行的方法，直接针对你的场景调整即可：

方法一：启用命令的AllowUnrecognizedArguments属性 #

这是最直接的方案，给目标命令开启该属性后，会自动忽略所有未在代码中定义的选项和参数。

修正后的示例代码：

var root = new RootCommand("Test application");
var cmd = new Command("example", "example command")
{
    // 开启忽略未识别参数的配置
    AllowUnrecognizedArguments = true
};

// 添加你需要关注的关键选项
var startDirOption = new Option<string>("--startDir", "指定起始目录");
var fileCntOption = new Option<int>("--FileCnt", "指定文件数量");
cmd.AddOption(startDirOption);
cmd.AddOption(fileCntOption);

// 绑定命令处理逻辑
cmd.SetHandler((startDir, fileCnt) =>
{
    Console.WriteLine($"解析到起始目录: {startDir}");
    Console.WriteLine($"解析到文件数量: {fileCnt}");
}, startDirOption, fileCntOption);

root.Add(cmd);
await root.InvokeAsync(args);

用test example --startDir=C:\temp --FileCnt=7 --Delay=10调用时，程序会正常解析你关注的两个选项，自动忽略--Delay=10这类未定义参数，不会再抛出未识别错误。

方法二：自定义中间件处理未识别参数 #

如果需要对未识别参数做额外操作（比如记录日志），可以通过中间件拦截并忽略：

var root = new RootCommand("Test application");
var cmd = new Command("example", "example command");

// 添加需要解析的关键选项
var startDirOption = new Option<string>("--startDir", "指定起始目录");
cmd.AddOption(startDirOption);

// 添加中间件捕获未识别参数
cmd.AddMiddleware(async (context, next) =>
{
    var unrecognizedArgs = context.ParseResult.UnrecognizedTokens;
    if (unrecognizedArgs.Any())
    {
        // 可选：记录未识别的参数
        Console.WriteLine($"已忽略未识别参数: {string.Join(", ", unrecognizedArgs)}");
    }
    // 继续执行后续命令逻辑
    await next(context);
});

cmd.SetHandler((startDir) =>
{
    Console.WriteLine($"解析到起始目录: {startDir}");
}, startDirOption);

root.Add(cmd);

// 关闭默认的解析错误报告，避免触发报错
var builder = new CommandLineBuilder(root);
builder.UseParseErrorReporting(false);
await builder.Build().InvokeAsync(args);

注意点 #

• 命令名称不要加--前缀，比如应该用new Command("example", ...)而非"--example"，--是选项的标识，命令名称不需要。
• AllowUnrecognizedArguments是针对单个命令的配置，要给接收未识别参数的子命令设置，而非根命令。

内容的提问来源于stack exchange，提问作者briddums