Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

docs: prefer npm package for CLI install (#2012)

Zayn Jarvis41514b867bf3
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ff6df08b9..7b3b15dde 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -121,8 +121,8 @@ Even if you do not plan to use `ov` directly, the Rust toolchain is still requir
# Build and install from source
cargo install --path crates/ov_cli
-# Or use the quick install script (downloads pre-built binary)
-curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash
+# Or install the published npm CLI package (downloads pre-built binary)
+npm i -g @openviking/cli
```
After installation, run `ov --help` to see all available commands. CLI connection config goes in `~/.openviking/ovcli.conf`.
diff --git a/CONTRIBUTING_CN.md b/CONTRIBUTING_CN.md
index 909f3d240..c0b161bf2 100644
--- a/CONTRIBUTING_CN.md
+++ b/CONTRIBUTING_CN.md
@@ -121,8 +121,8 @@ Rust CLI (`ov`) 提供高性能的命令行客户端,用于连接 OpenViking S
# 从源码编译安装
cargo install --path crates/ov_cli
-# 或者使用一键安装脚本(下载预编译二进制)
-curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash
+# 或者安装已发布的 npm CLI 包(下载预编译二进制)
+npm i -g @openviking/cli
```
安装后通过 `ov --help` 查看所有可用命令。CLI 连接配置见 `~/.openviking/ovcli.conf`。
diff --git a/CONTRIBUTING_JA.md b/CONTRIBUTING_JA.md
index 17f9d9587..85ccfa291 100644
--- a/CONTRIBUTING_JA.md
+++ b/CONTRIBUTING_JA.md
@@ -123,8 +123,8 @@ Rust CLI(`ov`)は、OpenViking Serverとやり取りするための高性能
# ソースからビルドしてインストール
cargo install --path crates/ov_cli
-# またはクイックインストールスクリプトを使用(プリビルドバイナリをダウンロード)
-curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash
+# または公開済みの npm CLI パッケージをインストール(プリビルドバイナリをダウンロード)
+npm i -g @openviking/cli
```
インストール後、`ov --help`を実行して利用可能なすべてのコマンドを確認できます。CLI接続設定は`~/.openviking/ovcli.conf`に記述します。
diff --git a/README.md b/README.md
index 794a73023..a78b5d37e 100644
--- a/README.md
+++ b/README.md
@@ -80,7 +80,7 @@ pip install openviking --upgrade --force-reinstall
#### Rust CLI (Optional)
```bash
-curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash
+npm i -g @openviking/cli
```
Or build from source:
diff --git a/README_CN.md b/README_CN.md
index 8d3a8d19d..addd4d4e5 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -78,7 +78,7 @@ pip install openviking --upgrade --force-reinstall
#### Rust CLI(可选)
```bash
-curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash
+npm i -g @openviking/cli
```
或从源码构建:
diff --git a/README_JA.md b/README_JA.md
index 394d44a8f..703332c93 100644
--- a/README_JA.md
+++ b/README_JA.md
@@ -80,7 +80,7 @@ pip install openviking --upgrade --force-reinstall
#### Rust CLI(オプション)
```bash
-curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash
+npm i -g @openviking/cli
```
またはソースからビルド:
diff --git a/crates/ov_cli/README.md b/crates/ov_cli/README.md
index a63c39b22..068058c2a 100644
--- a/crates/ov_cli/README.md
+++ b/crates/ov_cli/README.md
@@ -4,10 +4,10 @@ Command-line interface for [OpenViking](https://github.com/volcengine/OpenViking
## Installation
-### Quick Install (Linux/macOS)
+### Install from npm (macOS/Linux/Windows)
```bash
-curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash
+npm i -g @openviking/cli
```
### From Source
diff --git a/crates/ov_cli/install.sh b/crates/ov_cli/install.sh
index 2b3d1cb47..99c602647 100755
--- a/crates/ov_cli/install.sh
+++ b/crates/ov_cli/install.sh
@@ -1,10 +1,12 @@
#!/bin/bash
set -e
-# OpenViking CLI Installer
-# Usage: curl -fsSL https://raw.githubusercontent.com/<OWNER>/<REPO>/refs/tags/<TAG>/crates/ov_cli/install.sh | bash
-# Example: curl -fsSL https://raw.githubusercontent.com/volcengine/openviking/refs/tags/[email protected]/crates/ov_cli/install.sh | bash
-# Skip checksum: curl -fsSL ... | SKIP_CHECKSUM=1 bash
+# OpenViking CLI Installer (legacy GitHub Releases path)
+# Prefer npm for new installs:
+# npm i -g @openviking/cli
+# Alternative TOS installer:
+# curl -fsSL http://openviking.tos-cn-beijing.volces.com/cli/install.sh | bash
+# Skip checksum: SKIP_CHECKSUM=1 bash install.sh
# Custom repo: REPO=owner/repo curl -fsSL ... | bash
REPO="${REPO:-volcengine/openviking}"
@@ -201,4 +203,4 @@ main() {
}
# Run main function
-main "$@"
\ No newline at end of file
+main "$@"
diff --git a/openviking/server/mcp_endpoint.py b/openviking/server/mcp_endpoint.py
index 8db6faa4c..564e64078 100644
--- a/openviking/server/mcp_endpoint.py
+++ b/openviking/server/mcp_endpoint.py
@@ -339,8 +339,8 @@ _LOCAL_FILE_HINT = (
"For local files or directories, use the `ov` CLI:\n"
" 1. Try first: ov add-resource <path>\n"
" (if `ov` is already on PATH, this is all you need)\n"
- " 2. If `ov` is not installed, run:\n"
- " curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash\n"
+ " 2. If `ov` is not installed, install the npm CLI package:\n"
+ " npm i -g @openviking/cli\n"
" 3. Only if connecting to a remote / multi-tenant OpenViking server, "
"configure ~/.openviking/ovcli.conf:\n"
' {"url": "https://your-host", "api_key": "your-key"}'
diff --git a/openviking_cli/rust_cli.py b/openviking_cli/rust_cli.py
index 35823f1c1..270e3037a 100644
--- a/openviking_cli/rust_cli.py
+++ b/openviking_cli/rust_cli.py
@@ -98,8 +98,8 @@ def main():
1. 使用预构建 wheel(推荐):
pip install openviking --upgrade --force-reinstall
- 2. 使用官方安装脚本(零 Python 开销):
- curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/crates/ov_cli/install.sh | bash
+ 2. 使用 npm 安装原生 CLI 包(零 Python 开销):
+ npm i -g @openviking/cli
3. 从 GitHub Releases 下载(零 Python 开销):
https://github.com/volcengine/OpenViking/releases