为了更高效地开发与调试 UltraRAG,你可以通过 VSCode 的调试功能运行指定的 Pipeline 配置,并进行断点调试。

步骤一:创建调试配置文件

在项目根目录下创建 .vscode/launch.json 文件,并写入以下内容:
/images/json.svg.vscode/launch.json
{
    "configurations": [
        {
            "name": "UltraRAG Debug",
            "type": "debugpy",
            "request": "launch",
            "program": "${workspaceFolder}/src/ultrarag_mcp/client.py",
            "console": "integratedTerminal",
            "args": [
                "run",
                "${workspaceFolder}/examples/xxx.yaml" # 替换为你的 Pipeline 配置文件路径
            ],
            "cwd": "${workspaceFolder}",
        }
    ]
}

步骤二:启动调试

  1. 打开 VSCode 左侧的调试面板(快捷键 Ctrl+Shift+D)。
  2. 在调试配置中选择 UltraRAG Debug。
  3. 点击绿色 ▶ 启动按钮,即可在 VSCode 内集成终端中运行并调试。
你可以在任意 Python 文件中设置断点,以逐步观察执行流程和变量状态。