如何为System.CommandLine .NET 9命令行应用添加--interactive交互模式？

我开发了一个基于System.CommandLine的.NET 9命令行应用，主要用于定时任务场景，但有时需要用户手动运行。手动运行时，尽管帮助文档完善，用户仍难以构建正确的命令行。我希望添加一个--interactive（或-i）模式标志，启用后所有缺失的必填命令或选项会转为交互式提示。

当前根命令定义如下：

var rootCommand = new RootCommand("Command-line interface") {
    new Command(["example-a", "a"], "Do something"),
    new Command(["example-b", "b"], "Do something else")
};

用户未指定命令时会显示默认的缺失命令提示，但应用包含大量层级较深的命令，部分命令还需要多个带验证规则的必填选项（如文件路径、URL）。我想要的交互模式效果示例：

C:\Users\me>myApp --interactive

Choose a Command:
     example-a  Do something
   > example-b  Do something else

我可以逐个修改命令，在每个SetHandler里加Console.ReadLine，但会造成大量代码重复；另一种思路是通过ParseResult.Errors构建提示，但从零实现要处理大量复杂场景，且命令、参数和选项的配置有私有实现，只能反射访问。

请问有没有更优的实现方式？System.CommandLine是否内置相关功能？毕竟官方文档已预留--interactive和-i用于这类交互式提示。

解决方案 #

1. 自定义全局中间件（最优方案） #

System.CommandLine目前没有直接内置交互式模式，但可以通过全局中间件实现统一的交互逻辑，完全避免代码重复。核心思路是在命令解析完成后，检查是否启用了--interactive标志，针对解析错误（缺失必填命令/选项）生成交互式提示，补全参数后重新解析执行。

步骤实现：

首先定义全局的--interactive选项：

var interactiveOption = new Option<bool>("--interactive", "启用交互式模式") {
    Aliases = { "-i" }
};
rootCommand.AddGlobalOption(interactiveOption);

然后注册自定义中间件，处理交互逻辑：

rootCommand.SetMiddleware(async (context, next) => {
    var isInteractive = context.ParseResult.GetValueForOption(interactiveOption);
    if (!isInteractive) {
        await next(context);
        return;
    }

    // 处理缺失子命令的情况
    if (context.ParseResult.Errors.Any(e => e is MissingCommandError)) {
        var currentCommand = context.ParseResult.CommandResult.Command;
        var availableCommands = currentCommand.Subcommands.OrderBy(c => c.Name);
        
        Console.WriteLine("\nChoose a Command:");
        // 简化实现：支持输入命令名或序号选择
        for (int i = 0; i < availableCommands.Count(); i++) {
            var cmd = availableCommands.ElementAt(i);
            Console.WriteLine($"   [{i}] {cmd.Name,-10} {cmd.Description}");
        }
        
        Console.Write("\n请输入命令名或序号：");
        var input = Console.ReadLine()?.Trim();
        string targetCommandName = null;
        
        if (int.TryParse(input, out int index) && index >= 0 && index < availableCommands.Count()) {
            targetCommandName = availableCommands.ElementAt(index).Name;
        } else if (!string.IsNullOrEmpty(input)) {
            targetCommandName = input;
        }
        
        if (!string.IsNullOrEmpty(targetCommandName)) {
            // 构造新的命令行参数，追加选中的命令
            var newArgs = context.ParseResult.Tokens.Select(t => t.Value).ToList();
            newArgs.Add(targetCommandName);
            // 重新解析执行
            await rootCommand.InvokeAsync(newArgs, context.CancellationToken);
            return;
        }
    }

    // 处理缺失必填选项的情况
    foreach (var error in context.ParseResult.Errors.OfType<MissingRequiredOptionError>()) {
        var option = error.Option;
        string inputValue = null;
        
        do {
            Console.WriteLine($"\n请输入{option.Name}（{option.Description}）:");
            inputValue = Console.ReadLine()?.Trim();
            
            // 复用System.CommandLine的验证规则
            var validationResult = option.Validate(inputValue);
            if (!validationResult.Successful) {
                Console.WriteLine($"错误：{string.Join(", ", validationResult.Message)}");
                inputValue = null;
            }
        } while (string.IsNullOrEmpty(inputValue));
        
        // 构造新参数，补全选项值
        var newArgs = context.ParseResult.Tokens.Select(t => t.Value).ToList();
        newArgs.Add($"--{option.Name}");
        newArgs.Add(inputValue);
        await rootCommand.InvokeAsync(newArgs, context.CancellationToken);
        return;
    }

    // 无需要补全的内容，执行原命令逻辑
    await next(context);
}, MiddlewareOrder.PostParse);

2. 封装交互式工具类 #

如果需要处理更复杂的层级命令或多种参数类型，可以把交互式选择、输入逻辑封装成独立的工具类，比如：

public static class InteractivePrompt
{
    public static Command SelectCommand(IEnumerable<Command> commands)
    {
        // 扩展实现：支持上下箭头选择、高亮选中项等交互逻辑
        var commandList = commands.OrderBy(c => c.Name).ToList();
        int selectedIndex = 0;
        
        do {
            Console.Clear();
            Console.WriteLine("\nChoose a Command:");
            for (int i = 0; i < commandList.Count; i++) {
                var cmd = commandList[i];
                var prefix = i == selectedIndex ? ">" : " ";
                Console.WriteLine($"   {prefix} {cmd.Name,-10} {cmd.Description}");
            }
            
            var key = Console.ReadKey(true);
            if (key.Key == ConsoleKey.DownArrow && selectedIndex < commandList.Count - 1) {
                selectedIndex++;
            } else if (key.Key == ConsoleKey.UpArrow && selectedIndex > 0) {
                selectedIndex--;
            } else if (key.Key == ConsoleKey.Enter) {
                return commandList[selectedIndex];
            }
        } while (true);
    }

    public static string InputOptionValue(Option option)
    {
        string inputValue = null;
        do {
            Console.WriteLine($"\n请输入{option.Name}（{option.Description}）:");
            inputValue = Console.ReadLine()?.Trim();
            
            var validationResult = option.Validate(inputValue);
            if (!validationResult.Successful) {
                Console.WriteLine($"错误：{string.Join(", ", validationResult.Message)}");
                inputValue = null;
            }
        } while (string.IsNullOrEmpty(inputValue));
        return inputValue;
    }
}

在中间件中直接调用这些方法，让代码更清晰易维护。

3. 关键注意事项 #

• 复用验证逻辑：不要自己重新写选项验证，直接调用Option.Validate()方法，保证和命令行模式的验证规则一致。
• 递归处理层级命令：如果子命令下还有子命令或必填选项，重新解析后中间件会再次触发交互逻辑，实现逐层引导。
• 用户体验优化：可以添加输入补全、历史记录、错误提示高亮等功能，提升手动用户的操作体验。

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