Skip to content

docs(openclaw): surface openclaw openviking status / --json in Verify section (#1904) #1924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
qin-ctx merged 1 commit into from
May 9, 2026
Merged

docs(openclaw): surface openclaw openviking status / --json in Verify section (#1904) #1924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/en/agent-integrations/03-openclaw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
12 changes: 10 additions & 2 deletions docs/zh/agent-integrations/03-openclaw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 看