Skip to content

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

docs: use openviking-server to launch server (#398)

MaojiaShengab849f44f252
diff --git a/docs/en/concepts/01-architecture.md b/docs/en/concepts/01-architecture.md
index 88a136f12..832208978 100644
--- a/docs/en/concepts/01-architecture.md
+++ b/docs/en/concepts/01-architecture.md
@@ -150,7 +150,7 @@ curl http://localhost:1933/api/v1/search/find \
-d '{"query": "how to use openviking"}'
```
-- Server runs as standalone process (`python -m openviking serve`)
+- Server runs as standalone process (`openviking-server`)
- Clients connect via HTTP API
- Supports any language that can make HTTP requests
- See [Server Deployment](../guides/03-deployment.md) for setup
diff --git a/docs/en/getting-started/03-quickstart-server.md b/docs/en/getting-started/03-quickstart-server.md
index 7f4361c6a..cb4c98657 100644
--- a/docs/en/getting-started/03-quickstart-server.md
+++ b/docs/en/getting-started/03-quickstart-server.md
@@ -13,13 +13,13 @@ Make sure you have a config file at `~/.openviking/ov.conf` with your model and
```bash
# Config file at default path ~/.openviking/ov.conf — just start
-python -m openviking serve
+openviking-server
# Config file at a different location — specify with --config
-python -m openviking serve --config /path/to/ov.conf
+openviking-server --config /path/to/ov.conf
# Override host/port
-python -m openviking serve --port 8000
+openviking-server --port 8000
```
You should see:
diff --git a/docs/en/guides/01-configuration.md b/docs/en/guides/01-configuration.md
index 0444650c9..764d70471 100644
--- a/docs/en/guides/01-configuration.md
+++ b/docs/en/guides/01-configuration.md
@@ -548,7 +548,7 @@ export OPENVIKING_CONFIG_FILE=/path/to/ov.conf
export OPENVIKING_CLI_CONFIG_FILE=/path/to/ovcli.conf
# Option 2: Command-line argument (serve command only)
-python -m openviking serve --config /path/to/ov.conf
+openviking-server --config /path/to/ov.conf
```
### ov.conf
diff --git a/docs/en/guides/03-deployment.md b/docs/en/guides/03-deployment.md
index fab848bab..4d1f1cd5c 100644
--- a/docs/en/guides/03-deployment.md
+++ b/docs/en/guides/03-deployment.md
@@ -6,10 +6,10 @@ OpenViking can run as a standalone HTTP server, allowing multiple clients to con
```bash
# Start server (reads ~/.openviking/ov.conf by default)
-python -m openviking serve
+openviking-server
# Or specify a custom config path
-python -m openviking serve --config /path/to/ov.conf
+openviking-server --config /path/to/ov.conf
# Verify it's running
curl http://localhost:1933/health
@@ -28,13 +28,13 @@ curl http://localhost:1933/health
```bash
# With default config
-python -m openviking serve
+openviking-server
# With custom port
-python -m openviking serve --port 8000
+openviking-server --port 8000
# With custom config, host, and port
-python -m openviking serve --config /path/to/ov.conf --host 127.0.0.1 --port 8000
+openviking-server --config /path/to/ov.conf --host 127.0.0.1 --port 8000
```
## Configuration
@@ -76,7 +76,7 @@ Server manages local AGFS and VectorDB. Configure the storage path in `ov.conf`:
```
```bash
-python -m openviking serve
+openviking-server
```
### Hybrid (Remote Storage)
@@ -93,7 +93,7 @@ Server connects to remote AGFS and VectorDB services. Configure remote URLs in `
```
```bash
-python -m openviking serve
+openviking-server
```
## Deploying with Systemd (Recommended)
diff --git a/docs/en/guides/04-authentication.md b/docs/en/guides/04-authentication.md
index c6a76d768..aa13f9830 100644
--- a/docs/en/guides/04-authentication.md
+++ b/docs/en/guides/04-authentication.md
@@ -28,7 +28,7 @@ Configure the root API key in the `server` section of `ov.conf`:
Start the server:
```bash
-python -m openviking serve
+openviking-server
```
## Managing Accounts and Users
diff --git a/docs/zh/concepts/01-architecture.md b/docs/zh/concepts/01-architecture.md
index 101917f32..a90040e94 100644
--- a/docs/zh/concepts/01-architecture.md
+++ b/docs/zh/concepts/01-architecture.md
@@ -149,7 +149,7 @@ curl http://localhost:1933/api/v1/search/find \
-d '{"query": "how to use openviking"}'
```
-- Server 作为独立进程运行(`python -m openviking serve`)
+- Server 作为独立进程运行(`openviking-server`)
- 客户端通过 HTTP API 连接
- 支持任何能发起 HTTP 请求的语言
- 参见 [服务部署](../guides/03-deployment.md) 了解配置方法
diff --git a/docs/zh/getting-started/03-quickstart-server.md b/docs/zh/getting-started/03-quickstart-server.md
index 6053e0b7a..f5dd5ed04 100644
--- a/docs/zh/getting-started/03-quickstart-server.md
+++ b/docs/zh/getting-started/03-quickstart-server.md
@@ -13,13 +13,13 @@
```bash
# 配置文件在默认路径 ~/.openviking/ov.conf 时,直接启动
-python -m openviking serve
+openviking-server
# 配置文件在其他位置时,通过 --config 指定
-python -m openviking serve --config /path/to/ov.conf
+openviking-server --config /path/to/ov.conf
# 覆盖 host/port
-python -m openviking serve --port 1933
+openviking-server --port 1933
```
你应该看到:
diff --git a/docs/zh/guides/01-configuration.md b/docs/zh/guides/01-configuration.md
index c8db6cbf9..457738cc9 100644
--- a/docs/zh/guides/01-configuration.md
+++ b/docs/zh/guides/01-configuration.md
@@ -557,7 +557,7 @@ export OPENVIKING_CONFIG_FILE=/path/to/ov.conf
export OPENVIKING_CLI_CONFIG_FILE=/path/to/ovcli.conf
# 方式二:命令行参数(仅 serve 命令)
-python -m openviking serve --config /path/to/ov.conf
+openviking-server --config /path/to/ov.conf
```
### ov.conf
diff --git a/docs/zh/guides/03-deployment.md b/docs/zh/guides/03-deployment.md
index e20ba6671..d6f615fde 100644
--- a/docs/zh/guides/03-deployment.md
+++ b/docs/zh/guides/03-deployment.md
@@ -6,10 +6,10 @@ OpenViking 可以作为独立的 HTTP 服务器运行,允许多个客户端通
```bash
# 配置文件在默认路径 ~/.openviking/ov.conf 时,直接启动
-python -m openviking serve
+openviking-server
# 配置文件在其他位置时,通过 --config 指定
-python -m openviking serve --config /path/to/ov.conf
+openviking-server --config /path/to/ov.conf
# 验证服务器是否运行
curl http://localhost:1933/health
@@ -28,13 +28,13 @@ curl http://localhost:1933/health
```bash
# 使用默认配置
-python -m openviking serve
+openviking-server
# 使用自定义端口
-python -m openviking serve --port 8000
+openviking-server --port 8000
# 指定配置文件、主机地址和端口
-python -m openviking serve --config /path/to/ov.conf --host 127.0.0.1 --port 8000
+openviking-server --config /path/to/ov.conf --host 127.0.0.1 --port 8000
```
## 配置
@@ -76,7 +76,7 @@ python -m openviking serve --config /path/to/ov.conf --host 127.0.0.1 --port 800
```
```bash
-python -m openviking serve
+openviking-server
```
### 混合模式(远程存储)
@@ -93,7 +93,7 @@ python -m openviking serve
```
```bash
-python -m openviking serve
+openviking-server
```
## 使用 Systemd 部署服务(推荐)
diff --git a/docs/zh/guides/04-authentication.md b/docs/zh/guides/04-authentication.md
index 8b0030a22..53fbeb1b0 100644
--- a/docs/zh/guides/04-authentication.md
+++ b/docs/zh/guides/04-authentication.md
@@ -28,7 +28,7 @@ OpenViking 使用两层 API Key 体系:
启动服务:
```bash
-python -m openviking serve
+openviking-server
```
## 管理账户和用户
diff --git a/examples/multi_tenant/README.md b/examples/multi_tenant/README.md
index 7fc0a8c7a..898368cdb 100644
--- a/examples/multi_tenant/README.md
+++ b/examples/multi_tenant/README.md
@@ -63,11 +63,11 @@ cp ov.conf.example ov.conf
```bash
# 方式一:指定配置文件
-python -m openviking serve --config ./ov.conf
+openviking-server --config ./ov.conf
# 方式二:放到默认路径
cp ov.conf ~/.openviking/ov.conf
-python -m openviking serve
+openviking-server
# 验证
curl http://localhost:1933/health
diff --git a/examples/multi_tenant/admin_workflow.py b/examples/multi_tenant/admin_workflow.py
index 68a66d28f..1737f7440 100644
--- a/examples/multi_tenant/admin_workflow.py
+++ b/examples/multi_tenant/admin_workflow.py
@@ -19,7 +19,7 @@ Prerequisites:
}
}
- python -m openviking serve
+ openviking-server
Usage:
uv run admin_workflow.py