From 89969ea849fc8f71222ba9e117ecacd0544c2fb1 Mon Sep 17 00:00:00 2001 From: openviking Date: Wed, 4 Mar 2026 20:22:01 +0800 Subject: [PATCH] docs: pip upgrade suggestion --- README.md | 2 +- README_CN.md | 2 +- docs/en/faq/faq.md | 5 +++-- docs/en/getting-started/02-quickstart.md | 2 +- docs/en/getting-started/03-quickstart-server.md | 2 +- docs/zh/faq/faq.md | 2 +- docs/zh/getting-started/02-quickstart.md | 2 +- docs/zh/getting-started/03-quickstart-server.md | 2 +- examples/cloud/GUIDE.md | 6 +++--- examples/openclaw-memory-plugin/INSTALL-ZH.md | 10 +++++----- examples/openclaw-memory-plugin/INSTALL.md | 10 +++++----- examples/openclaw-memory-plugin/README.md | 2 +- examples/openclaw-memory-plugin/setup-helper/cli.js | 4 ++-- .../skills/install-openviking-memory/SKILL.md | 12 ++++++------ examples/opencode/plugin/README.md | 2 +- examples/opencode/plugin/skills/openviking/SKILL.md | 2 +- openviking/eval/README.md | 2 +- openviking_cli/rust_cli.py | 2 +- 18 files changed, 36 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 39d363f9..0a78d319 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ Before starting with OpenViking, please ensure your environment meets the follow #### Python Package ```bash -pip install openviking +pip install openviking --upgrade --force-reinstall ``` #### Rust CLI (Optional) diff --git a/README_CN.md b/README_CN.md index 8b276de0..a602faf9 100644 --- a/README_CN.md +++ b/README_CN.md @@ -67,7 +67,7 @@ #### Python 包 ```bash -pip install openviking +pip install openviking --upgrade --force-reinstall ``` #### Rust CLI（可选） diff --git a/docs/en/faq/faq.md b/docs/en/faq/faq.md index 2c81a723..e03bd4af 100644 --- a/docs/en/faq/faq.md +++ b/docs/en/faq/faq.md @@ -61,10 +61,11 @@ viking:// - VLM (Vision Language Model): For multimodal content processing and semantic extraction - Rerank model: For improved retrieval precision -### How do I install OpenViking? +### How do I install/upgrade OpenViking? ```bash -pip install openviking +pip install openviking --upgrade --force-reinstall + ``` ### How do I configure OpenViking? diff --git a/docs/en/getting-started/02-quickstart.md b/docs/en/getting-started/02-quickstart.md index 2edec0f4..6861fbe3 100644 --- a/docs/en/getting-started/02-quickstart.md +++ b/docs/en/getting-started/02-quickstart.md @@ -13,7 +13,7 @@ Before using OpenViking, ensure your environment meets the following requirement ## Installation ```bash -pip install openviking +pip install openviking --upgrade --force-reinstall ``` ## Model Preparation diff --git a/docs/en/getting-started/03-quickstart-server.md b/docs/en/getting-started/03-quickstart-server.md index cb4c9865..b6e8ce61 100644 --- a/docs/en/getting-started/03-quickstart-server.md +++ b/docs/en/getting-started/03-quickstart-server.md @@ -4,7 +4,7 @@ Run OpenViking as a standalone HTTP server and connect from any client. ## Prerequisites -- OpenViking installed (`pip install openviking`) +- OpenViking installed (`pip install openviking --upgrade --force-reinstall`) - Model configuration ready (see [Quick Start](02-quickstart.md) for setup) ## Start the Server diff --git a/docs/zh/faq/faq.md b/docs/zh/faq/faq.md index 822f7e12..1c702cee 100644 --- a/docs/zh/faq/faq.md +++ b/docs/zh/faq/faq.md @@ -64,7 +64,7 @@ viking:// ### 如何安装 OpenViking？ ```bash -pip install openviking +pip install openviking --upgrade --force-reinstall ``` ### 如何配置 OpenViking？ diff --git a/docs/zh/getting-started/02-quickstart.md b/docs/zh/getting-started/02-quickstart.md index 30d8b407..c74418fe 100644 --- a/docs/zh/getting-started/02-quickstart.md +++ b/docs/zh/getting-started/02-quickstart.md @@ -13,7 +13,7 @@ ## 安装 ```bash -pip install openviking +pip install openviking --upgrade --force-reinstall ``` ## 模型准备 diff --git a/docs/zh/getting-started/03-quickstart-server.md b/docs/zh/getting-started/03-quickstart-server.md index f5dd5ed0..3272c8d8 100644 --- a/docs/zh/getting-started/03-quickstart-server.md +++ b/docs/zh/getting-started/03-quickstart-server.md @@ -4,7 +4,7 @@ ## 前置要求 -- 已安装 OpenViking（`pip install openviking`） +- 已安装 OpenViking（`pip install openviking --upgrade --force-reinstall`） - 模型配置已就绪（参见 [快速开始](02-quickstart.md) 了解配置方法） ## 启动服务 diff --git a/examples/cloud/GUIDE.md b/examples/cloud/GUIDE.md index d4da87b5..68269bcc 100644 --- a/examples/cloud/GUIDE.md +++ b/examples/cloud/GUIDE.md @@ -19,7 +19,7 @@ ## 前置条件 - 火山引擎账号（[注册地址](https://console.volcengine.com/)） -- 已安装 OpenViking（`pip install openviking` 或从源码安装） +- 已安装 OpenViking（`pip install openviking --upgrade --force-reinstall` 或从源码安装） - Python 3.11+ --- @@ -164,7 +164,7 @@ cp examples/cloud/ov.conf.example examples/cloud/ov.conf > **开发调试**：如果只是本地快速验证，可以直接运行： > ```bash -> pip install openviking +> pip install openviking --upgrade --force-reinstall > > # 方式 A：放到默认路径 > mkdir -p ~/.openviking && cp examples/cloud/ov.conf ~/.openviking/ov.conf @@ -181,7 +181,7 @@ cp examples/cloud/ov.conf.example examples/cloud/ov.conf 1. 安装 OpenViking： ```bash -pip install openviking +pip install openviking --upgrade --force-reinstall ``` 2. 将配置文件放到固定路径： diff --git a/examples/openclaw-memory-plugin/INSTALL-ZH.md b/examples/openclaw-memory-plugin/INSTALL-ZH.md index 18bcd2c1..08322a3d 100644 --- a/examples/openclaw-memory-plugin/INSTALL-ZH.md +++ b/examples/openclaw-memory-plugin/INSTALL-ZH.md @@ -62,8 +62,8 @@ copy examples\openclaw-memory-plugin\skills\install-openviking-memory\SKILL.md ^ | **火山引擎 Ark API Key** | — | Embedding + VLM 模型调用 | 是 | > **PyPI 安装 vs 源码安装：** -> - `pip install openviking`（PyPI 预编译包）：只需 Python、cmake、g++，**不需要 Go** -> - `pip install -e .`（源码安装）：需要 Python、cmake、g++ **以及 Go >= 1.25**（Linux 上编译 AGFS） +> - `pip install openviking --upgrade --force-reinstall`（PyPI 预编译包）：只需 Python、cmake、g++，**不需要 Go** +> - `pip install -e . --force-reinstall`（源码安装）：需要 Python、cmake、g++ **以及 Go >= 1.25**（Linux 上编译 AGFS） > - **Windows** 用户可直接使用预编译 wheel 包，无需 Go ### 快速检查 @@ -211,7 +211,7 @@ npm -v ### 3.4 安装 Go >= 1.25（仅源码安装需要） > 已安装？运行 `go version`，如果显示 >= go1.25 则跳过此步。 -> 使用 `pip install openviking`（PyPI 预编译包）的用户也可跳过。 +> 使用 `pip install openviking --upgrade --force-reinstall`（PyPI 预编译包）的用户也可跳过。 Linux 源码安装 OpenViking 时需要 Go 编译 AGFS 服务端。 @@ -285,7 +285,7 @@ cd OpenViking #### 方式 A：从 PyPI 安装（推荐，无需 Go） ```bash -python3 -m pip install openviking +python3 -m pip install openviking --upgrade --force-reinstall ``` #### 方式 B：从源码安装（开发者模式，需要 Go） @@ -627,7 +627,7 @@ python3 -m pip config set global.trusted-host pypi.tuna.tsinghua.edu.cn 单次安装时临时指定： ```bash -python3 -m pip install openviking -i https://pypi.tuna.tsinghua.edu.cn/simple +python3 -m pip install openviking --upgrade --force-reinstall -i https://pypi.tuna.tsinghua.edu.cn/simple ``` ### npm 镜像 diff --git a/examples/openclaw-memory-plugin/INSTALL.md b/examples/openclaw-memory-plugin/INSTALL.md index 1030693f..88ead88b 100644 --- a/examples/openclaw-memory-plugin/INSTALL.md +++ b/examples/openclaw-memory-plugin/INSTALL.md @@ -62,8 +62,8 @@ For manual installation, continue reading. | **Volcengine Ark API Key** | — | Embedding + VLM model calls | Yes | > **PyPI vs Source install:** -> - `pip install openviking` (pre-built package): needs Python, cmake, g++ — **no Go required** -> - `pip install -e .` (source install): needs Python, cmake, g++ **and Go >= 1.25** (to compile AGFS on Linux) +> - `pip install openviking --upgrade --force-reinstall` (pre-built package): needs Python, cmake, g++ — **no Go required** +> - `pip install -e . --force-reinstall` (source install): needs Python, cmake, g++ **and Go >= 1.25** (to compile AGFS on Linux) > - **Windows** users can use pre-built wheel packages without Go ### Quick Check @@ -211,7 +211,7 @@ npm -v ### 3.4 Install Go >= 1.25 (source install only) > Already installed? Run `go version` — if it shows >= go1.25, skip this step. -> Also skippable if using `pip install openviking` (pre-built package). +> Also skippable if using `pip install openviking --upgrade --force-reinstall` (pre-built package). Go is required on Linux to compile the AGFS server when installing from source. @@ -285,7 +285,7 @@ cd OpenViking #### Option A: Install from PyPI (recommended, no Go needed) ```bash -python3 -m pip install openviking +python3 -m pip install openviking --upgrade --force-reinstall ``` #### Option B: Install from Source (developer mode, requires Go) @@ -627,7 +627,7 @@ python3 -m pip config set global.trusted-host pypi.tuna.tsinghua.edu.cn Single-use: ```bash -python3 -m pip install openviking -i https://pypi.tuna.tsinghua.edu.cn/simple +python3 -m pip install openviking --upgrade --force-reinstall -i https://pypi.tuna.tsinghua.edu.cn/simple ``` ### npm Mirror diff --git a/examples/openclaw-memory-plugin/README.md b/examples/openclaw-memory-plugin/README.md index 11c4b45e..e0eea2fd 100644 --- a/examples/openclaw-memory-plugin/README.md +++ b/examples/openclaw-memory-plugin/README.md @@ -14,7 +14,7 @@ The setup helper checks the environment, creates `~/.openviking/ov.conf`, deploy ## Manual Setup -Prerequisites: **OpenClaw** (`npm install -g openclaw`), **Python >= 3.10** with `openviking` (`pip install openviking`). +Prerequisites: **OpenClaw** (`npm install -g openclaw`), **Python >= 3.10** with `openviking` (`pip install openviking --upgrade --force-reinstall`). ```bash # Install plugin diff --git a/examples/openclaw-memory-plugin/setup-helper/cli.js b/examples/openclaw-memory-plugin/setup-helper/cli.js index 8359fabc..c912d3fb 100755 --- a/examples/openclaw-memory-plugin/setup-helper/cli.js +++ b/examples/openclaw-memory-plugin/setup-helper/cli.js @@ -719,8 +719,8 @@ Env vars: await installOpenviking(repo); } else { log("Please install openviking manually and re-run this script.", "err"); - if (repo) console.log(` cd ${repo} && python3.11 -m pip install -e .`); - else console.log(" python3.11 -m pip install openviking"); + if (repo) console.log(` cd ${repo} && python3 -m pip install -e .`); + else console.log(" python3.11 -m pip install openviking --upgrade --force-reinstall"); process.exit(1); } } diff --git a/examples/openclaw-memory-plugin/skills/install-openviking-memory/SKILL.md b/examples/openclaw-memory-plugin/skills/install-openviking-memory/SKILL.md index 2a8b3c31..ce0fc362 100644 --- a/examples/openclaw-memory-plugin/skills/install-openviking-memory/SKILL.md +++ b/examples/openclaw-memory-plugin/skills/install-openviking-memory/SKILL.md @@ -66,7 +66,7 @@ openclaw --version ### 1.5 Check Go (>= 1.25) — only for source install on Linux -> Skip this check if the user will install via `pip install openviking` (PyPI pre-built package). +> Skip this check if the user will install via `pip install openviking --upgrade --force-reinstall` (PyPI pre-built package). ```bash go version @@ -95,7 +95,7 @@ Two options — choose based on the user's needs: #### Option A: Install from PyPI (recommended, no Go needed) ```bash -python3 -m pip install openviking +python3 -m pip install openviking --upgrade --force-reinstall ``` #### Option B: Install from Source (developer mode) @@ -105,17 +105,17 @@ Requires Go >= 1.25 on Linux (check passed in Step 1.5). **Linux / macOS:** ```bash -python3 -m pip install -e . +python3 -m pip install -e . --force-reinstall ``` **Windows:** ```powershell -python -m pip install -e . +python -m pip install -e . --force-reinstall ``` > If pip downloads are slow, suggest using a mirror: -> `python3 -m pip install openviking -i https://pypi.tuna.tsinghua.edu.cn/simple` +> `python3 -m pip install openviking --upgrade --force-reinstall -i https://pypi.tuna.tsinghua.edu.cn/simple` ### 2.3 Verify Installation @@ -132,7 +132,7 @@ python -c "import openviking; print('openviking module: ok')" ``` - **Pass:** Prints `openviking module: ok`. -- **Fail — multiple Python versions:** Ask the user which Python to use, then install with that path: `/path/to/python3.11 -m pip install openviking` +- **Fail — multiple Python versions:** Ask the user which Python to use, then install with that path: `/path/to/python3.11 -m pip install openviking --upgrade --force-reinstall` - **Fail — `TypeError: unsupported operand type(s) for |`:** Python version is below 3.10. The user needs to upgrade. - **Fail — `Go compiler not found`:** Go is not installed (source install only). See Step 1.5. diff --git a/examples/opencode/plugin/README.md b/examples/opencode/plugin/README.md index f87e11fd..0a482f4e 100644 --- a/examples/opencode/plugin/README.md +++ b/examples/opencode/plugin/README.md @@ -7,7 +7,7 @@ OpenViking plugin for [OpenCode](https://opencode.ai). Injects your indexed code Install the latest OpenViking and configure `~/.openviking/ov.conf`: ```bash -pip install openviking --upgrade +pip install openviking --upgrade --force-reinstall ``` ```json diff --git a/examples/opencode/plugin/skills/openviking/SKILL.md b/examples/opencode/plugin/skills/openviking/SKILL.md index c9a0b6ec..6478b05e 100644 --- a/examples/opencode/plugin/skills/openviking/SKILL.md +++ b/examples/opencode/plugin/skills/openviking/SKILL.md @@ -105,7 +105,7 @@ This permanently deletes the repo and all its indexed content. Confirm with the ## Error Handling -**`command not found: ov`** → Tell user: `pip install openviking --upgrade`. Stop. +**`command not found: ov`** → Tell user: `pip install openviking --upgrade --force-reinstall`. Stop. **`url is required` / `CLI_CONFIG` error** → Auto-create config and retry: ```bash diff --git a/openviking/eval/README.md b/openviking/eval/README.md index 8c340466..e1fbd288 100644 --- a/openviking/eval/README.md +++ b/openviking/eval/README.md @@ -66,7 +66,7 @@ class BaseEvaluator(ABC): ```bash # 基础安装 -pip install openviking +pip install openviking --upgrade --force-reinstall # RAGAS 评估支持 pip install ragas datasets diff --git a/openviking_cli/rust_cli.py b/openviking_cli/rust_cli.py index a3356f1b..8656074f 100644 --- a/openviking_cli/rust_cli.py +++ b/openviking_cli/rust_cli.py @@ -67,7 +67,7 @@ def main(): 请选择以下方式之一安装： 1. 使用预构建 wheel（推荐）： - pip install openviking + pip install openviking --upgrade --force-reinstall 2. 使用官方安装脚本（零 Python 开销）： curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash