From 7376748676e1699167f9e4b0444752f8f4b334eb Mon Sep 17 00:00:00 2001 From: r266-tech Date: Sat, 9 May 2026 00:30:25 +0800 Subject: [PATCH] docs(openclaw-plugin): surface `openclaw openviking status` in Verify section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Source: PR #1904 (LinQiang391, merged 2026-05-08T09:38:05Z by qin-ctx) added two CLI commands to the OpenViking OpenClaw plugin: - `openclaw openviking setup` — interactive + non-interactive (`--base-url ...`) with `--api-key`, `--agent-prefix`, `--account-id`, `--user-id`, `--allow-offline`, `--force-slot`, `--reconfigure`, `--zh`, `--json` - `openclaw openviking status` — `Show current OpenViking plugin status and connectivity`, with `--zh`, `--json` The integration page docs/{en,zh}/agent-integrations/03-openclaw.md was not touched by #1904; its Verify section still only lists indirect manual checks (`openclaw config get plugins.slots.contextEngine`, `openclaw logs --follow`, `cat openviking.log`, `ov-install --current-version`). None of those probe server compatibility or give a single-command health summary. This commit adds a small additive intro to Verify in both en + zh that: - Documents `openclaw openviking status` as the one-shot health check (registration, connectivity, version compatibility — calls `getStatus(configPath)` + `checkServiceHealth` + `formatCompatRange` per examples/openclaw-plugin/commands/setup.ts L590-612). - Calls out `--json` for automation, with the explicit caveat that `setup --json` requires `--base-url` (setup.ts L498 enforces this; without the caveat readers may attempt bare `setup --json` and hit `--json requires --base-url for non-interactive mode`). - Leaves all existing manual-signal verifications in place — the original steps are still useful for debugging individual layers. --- docs/en/agent-integrations/03-openclaw.md | 12 ++++++++++-- docs/zh/agent-integrations/03-openclaw.md | 12 ++++++++++-- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/en/agent-integrations/03-openclaw.md b/docs/en/agent-integrations/03-openclaw.md index 061c409db..3e09e4492 100644 --- a/docs/en/agent-integrations/03-openclaw.md +++ b/docs/en/agent-integrations/03-openclaw.md @@ -108,7 +108,15 @@ openclaw config set plugins.entries.openviking.config.agent_prefix your-prefix ## Verify -Check that the plugin owns the `contextEngine` slot: +For a one-shot health check covering plugin registration, server connectivity, and version compatibility, run: + +```bash +openclaw openviking status +``` + +For automation, append `--json` to `openclaw openviking status` to get a machine-readable result. `openclaw openviking setup` also supports `--json` when used with `--base-url`. + +Or check the underlying signals manually. The plugin owns the `contextEngine` slot: ```bash openclaw config get plugins.slots.contextEngine @@ -158,4 +166,4 @@ For a non-default OpenClaw state directory, append `--workdir ~/.openclaw-second - [Full install guide](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/INSTALL.md) — every install path, parameter, and verification step - [Plugin design notes](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/README.md) — architecture, identity & routing, hook lifecycle -- [Agent operator guide](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/INSTALL-AGENT.md) — for agents driving installation on behalf of a user +- [Agent operator guide](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/INSTALL-AGENT.md) — for agents driving installation on behalf of a user \ No newline at end of file diff --git a/docs/zh/agent-integrations/03-openclaw.md b/docs/zh/agent-integrations/03-openclaw.md index 4277ff1ba..2ec217416 100644 --- a/docs/zh/agent-integrations/03-openclaw.md +++ b/docs/zh/agent-integrations/03-openclaw.md @@ -108,7 +108,15 @@ openclaw config set plugins.entries.openviking.config.agent_prefix your-prefix ## 验证 -确认插件占用了 `contextEngine` 槽位： +要一键检查插件注册、服务端连通性和版本兼容性，运行： + +```bash +openclaw openviking status +``` + +自动化场景下，可为 `openclaw openviking status` 追加 `--json` 获取机器可读结果。`openclaw openviking setup` 也支持 `--json`，但自动化使用时需同时提供 `--base-url`。 + +或手动核对各个信号。确认插件占用了 `contextEngine` 槽位： ```bash openclaw config get plugins.slots.contextEngine @@ -158,4 +166,4 @@ bash uninstall-openviking.sh - [完整安装指南](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/INSTALL.md) — 所有安装路径、参数与验证步骤 - [插件设计说明](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/README.md) — 架构、身份与路由、hook 生命周期 -- [Agent 操作指南](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/INSTALL-AGENT.md) — 给代用户执行安装的 agent 看 +- [Agent 操作指南](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/INSTALL-AGENT.md) — 给代用户执行安装的 agent 看 \ No newline at end of file