From a556d18fb92343026e5a86c3a9ba5413b2ceaf17 Mon Sep 17 00:00:00 2001 From: MisonL <1360962086@qq.com> Date: Thu, 15 Oct 2026 00:46:17 +0800 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20=E8=A1=A5=E5=85=85=20--help=20?= =?UTF-8?q?=E7=94=A8=E6=B3=95=E3=80=81=E4=BA=AE/=E6=9A=97=E4=B8=BB?= =?UTF-8?q?=E9=A2=98=E9=80=82=E9=85=8D=E8=AF=B4=E6=98=8E=EF=BC=8C=E4=BF=AE?= =?UTF-8?q?=E6=AD=A3=E5=88=87=E6=8D=A2=E6=A8=A1=E5=9E=8B=E7=A4=BA=E4=BE=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - getting-started.md / user-guide.md / README.md 的运行章节补 命令行参数（-h/--help、--smoke-test）与 PYRAG_LIGHT/PYRAG_DARK 主题覆盖说明 - user-guide.md 的切换模型示例从过时的 google/openai（provider 名 而非配置 key）改为 llm_configurations 的实际 key，并补重载失败 自动回滚的说明（PR #3 落地的契约） Co-Authored-By: Claude Fable 5 --- README.md | 2 ++ docs/user_guide/getting-started.md | 8 ++++++++ docs/user_guide/user-guide.md | 4 +++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f3933eb..ac5d533 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,8 @@ cp .env.example .env uv run main.py ``` +命令行支持 `-h` / `--help`（查看用法）与 `--smoke-test`（非交互自检）；界面配色自动适配终端亮色 / 暗色主题，可用 `PYRAG_LIGHT=1` / `PYRAG_DARK=1` 强制指定。 + 3. 在主菜单中按需执行： - `1`：重建知识快照 - `2`：执行召回测试 diff --git a/docs/user_guide/getting-started.md b/docs/user_guide/getting-started.md index 67a118d..8aebf69 100644 --- a/docs/user_guide/getting-started.md +++ b/docs/user_guide/getting-started.md @@ -75,6 +75,14 @@ uv sync uv run main.py ``` +命令行参数： + +* `-h` / `--help`：打印用法说明并退出（不初始化依赖，瞬时返回，也无任何副作用）。 +* `--smoke-test`：非交互式启动自检，主要用于构建验证。 +* 无参数：进入交互式主菜单。 + +界面配色会自动适配终端的亮色 / 暗色主题（通过 `COLORFGBG` 环境变量检测，无信号时按暗色处理）；如检测不符，可用环境变量强制指定：`PYRAG_LIGHT=1`（亮色）或 `PYRAG_DARK=1`（暗色）。 + 程序启动后会进入主菜单，您可以按需执行： * **1. 知识库文档向量化处理**: 处理 `knowledge_base/` 目录中的 Markdown 文件，并生成新的本地知识快照。 diff --git a/docs/user_guide/user-guide.md b/docs/user_guide/user-guide.md index c08294f..137d3a1 100644 --- a/docs/user_guide/user-guide.md +++ b/docs/user_guide/user-guide.md @@ -6,6 +6,8 @@ 当您按照 [快速上手](./getting-started.md) 指南成功运行 `uv run main.py` 后，程序会进入主菜单。 +命令行支持 `-h` / `--help`（查看用法）与 `--smoke-test`（非交互自检）；界面配色自动适配终端亮色 / 暗色主题，检测不符时可用 `PYRAG_LIGHT=1` 或 `PYRAG_DARK=1` 强制指定。 + 您会看到类似以下的选项： ``` @@ -59,7 +61,7 @@ uv run python -m scripts.embed_knowledge_base --mode standard * **Rerank重排**: 启用或禁用 Rerank 模型进行二次精排。 * **混合搜索权重**: 当使用“混合检索”时，调整向量和关键词搜索结果的权重。 * **切换模型**: - * **语言模型 (LLM)**: 动态切换当前对话使用的聊天模型（例如，从 `google` 切换到 `openai`）。切换后，程序会自动重载模型。 + * **语言模型 (LLM)**: 动态切换当前对话使用的聊天模型（在 `config.toml` 中 `llm_configurations` 里定义的配置项之间切换，例如从 `gpt-5-6-sol` 切到 `deepseek-v4-flash`）。切换后，程序会自动重载模型；重载失败时自动回滚到原模型并提示。 * **重排模型 (Rerank)**: 切换用于精排的 Rerank 模型。 * **查看当前完整配置**: 显示所有当前生效的聊天和模型参数。 From 70b6a1b1aa4cbc68c1f2dcc284e8617486505ff9 Mon Sep 17 00:00:00 2001 From: MisonL <1360962086@qq.com> Date: Thu, 15 Oct 2026 08:52:29 +0800 Subject: [PATCH 2/2] =?UTF-8?q?docs:=20=E6=8C=89=20Sourcery=20=E5=A4=8D?= =?UTF-8?q?=E6=A0=B8=E6=94=B6=E7=AA=84=E4=B8=BB=E9=A2=98=E6=8F=8F=E8=BF=B0?= =?UTF-8?q?=E3=80=81=E4=BF=AE=E6=AD=A3=E6=A8=A1=E5=9E=8B=E7=A4=BA=E4=BE=8B?= =?UTF-8?q?=20key?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 主题适配范围如实化：只覆盖提示符与选择菜单指针（rich 语义色的 面板/表格本就自适应），不是「整个界面配色」 - 切换模型示例改用 config.toml.example 实际存在的 key（openai/ google-pro）；gpt-5-6-sol 是本机私有配置的 key，用户照文档操作 会在菜单里找不到该选项 Co-Authored-By: Claude Fable 5 --- README.md | 2 +- docs/user_guide/getting-started.md | 2 +- docs/user_guide/user-guide.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ac5d533..7d6195d 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ cp .env.example .env uv run main.py ``` -命令行支持 `-h` / `--help`（查看用法）与 `--smoke-test`（非交互自检）；界面配色自动适配终端亮色 / 暗色主题，可用 `PYRAG_LIGHT=1` / `PYRAG_DARK=1` 强制指定。 +命令行支持 `-h` / `--help`（查看用法）与 `--smoke-test`（非交互自检）；提示符与选择菜单指针的颜色自动适配终端亮色 / 暗色主题（面板、表格等其他元素沿用 rich 语义色），可用 `PYRAG_LIGHT=1` / `PYRAG_DARK=1` 强制指定。 3. 在主菜单中按需执行： - `1`：重建知识快照 diff --git a/docs/user_guide/getting-started.md b/docs/user_guide/getting-started.md index 8aebf69..892ce54 100644 --- a/docs/user_guide/getting-started.md +++ b/docs/user_guide/getting-started.md @@ -81,7 +81,7 @@ uv run main.py * `--smoke-test`：非交互式启动自检，主要用于构建验证。 * 无参数：进入交互式主菜单。 -界面配色会自动适配终端的亮色 / 暗色主题（通过 `COLORFGBG` 环境变量检测，无信号时按暗色处理）；如检测不符，可用环境变量强制指定：`PYRAG_LIGHT=1`（亮色）或 `PYRAG_DARK=1`（暗色）。 +提示符与选择菜单指针的颜色会自动适配终端的亮色 / 暗色主题（面板、表格等其他元素沿用 rich 语义色）。主题通过 `COLORFGBG` 环境变量检测，无信号时按暗色处理；如检测不符，可用环境变量强制指定：`PYRAG_LIGHT=1`（亮色）或 `PYRAG_DARK=1`（暗色）。 程序启动后会进入主菜单，您可以按需执行： diff --git a/docs/user_guide/user-guide.md b/docs/user_guide/user-guide.md index 137d3a1..d142c8b 100644 --- a/docs/user_guide/user-guide.md +++ b/docs/user_guide/user-guide.md @@ -6,7 +6,7 @@ 当您按照 [快速上手](./getting-started.md) 指南成功运行 `uv run main.py` 后，程序会进入主菜单。 -命令行支持 `-h` / `--help`（查看用法）与 `--smoke-test`（非交互自检）；界面配色自动适配终端亮色 / 暗色主题，检测不符时可用 `PYRAG_LIGHT=1` 或 `PYRAG_DARK=1` 强制指定。 +命令行支持 `-h` / `--help`（查看用法）与 `--smoke-test`（非交互自检）；提示符与选择菜单指针的颜色自动适配终端亮色 / 暗色主题（面板、表格等其他元素沿用 rich 语义色），检测不符时可用 `PYRAG_LIGHT=1` 或 `PYRAG_DARK=1` 强制指定。 您会看到类似以下的选项： @@ -61,7 +61,7 @@ uv run python -m scripts.embed_knowledge_base --mode standard * **Rerank重排**: 启用或禁用 Rerank 模型进行二次精排。 * **混合搜索权重**: 当使用“混合检索”时，调整向量和关键词搜索结果的权重。 * **切换模型**: - * **语言模型 (LLM)**: 动态切换当前对话使用的聊天模型（在 `config.toml` 中 `llm_configurations` 里定义的配置项之间切换，例如从 `gpt-5-6-sol` 切到 `deepseek-v4-flash`）。切换后，程序会自动重载模型；重载失败时自动回滚到原模型并提示。 + * **语言模型 (LLM)**: 动态切换当前对话使用的聊天模型（在 `config.toml` 中 `llm_configurations` 里定义的配置项之间切换，例如从 `openai` 切到 `google-pro`）。切换后，程序会自动重载模型；重载失败时自动回滚到原模型并提示。 * **重排模型 (Rerank)**: 切换用于精排的 Rerank 模型。 * **查看当前完整配置**: 显示所有当前生效的聊天和模型参数。