VS Code Config Helper v4

命令行界面

本软件除了图形界面(Graphical User Interface, GUI)外,还提供了命令行界面(Command Line Interface, CLI)。当图形界面不适用,或者需要批量配置时,CLI 模式便能派上用场。

如何使用 CLI

当程序未接收到任何命令行参数时,将默认使用 GUI。如果你在启动程序时,传递了额外的命令行参数,则程序会改为使用 CLI(启用 --gui 开关除外)。

因此,你可以使用 --cli 参数来启动本程序,这样便会使用 CLI。

./vscch --cli

--cli 参数没有任何作用,单纯是为了破坏“未接收到任何命令行参数”的状态。

此外,如果 Windows 系统下没有安装 WebView 2 运行时,程序也将退化到 CLI。

交互模式与非交互模式

CLI 具体细分为两种模式:交互模式(Interactive mode)与 非交互模式(Non-interactive mode)。

它们的具体区别是,如果软件需要用户提供更多的信息,交互模式 下会以提示符(Prompt)的形式询问并获得用户输入;而 非交互模式 下则会得到运行时错误并终止程序。总之,交互模式 更适合用户直接运行,而 非交互模式 适合批处理、定时计划等场景。

默认的模式是 交互模式。传入 -y--assume-yes 参数来启用 非交互模式

交互模式使用说明

注:以下用户输入都可以通过传递命令行参数来跳过。

VS Code 选择

请首先输入 VS Code 可执行文件的路径。如果工具检测到了已有的 VS Code 安装,则默认值已经就绪,直接回车下一步即可。

编译器类型选择

按上、下键选择你想要使用的编译器类型;按回车确定。

编译器路径选择

如果当前类型的编译器有且只有一个安装,则这一步骤会被跳过。

否则,从已安装的编译器中选择你想要使用的,或者进行如下操作之一:

工作文件夹

输入工作文件夹路径;不合法(如 MinGW-w64 下的中文路径)时工具会提示。

等待配置完成

工具会按照你提供的信息,并以默认设置完成配置。CLI 模式下,工具不会自动启动 VS Code;你需要手动打开工作文件夹并测试配置效果。

非交互模式使用说明

你需要在启动程序时使用以下参数:

参数名   含义
-y 必需 启用非交互模式
-w <PATH> 必需 指定工作文件夹路径
-v 建议 启用更多输出;越多越具体(如 -vvv
-s <SETUP_NAME> 可选 指定编译器类型;可通过 --help 获得类型名称
-c <PATH> 可选 指定编译器路径;若编译器不存在或不唯一则报错
--vscode <PATH> 可选 指定 VS Code 路径;若未安装则报错

更多的参数说明请参考配置选项说明