docs(openclaw): surface openclaw openviking status / --json in Verify section (#1904)#1924
Merged
qin-ctx merged 1 commit intovolcengine:mainfrom May 9, 2026
Conversation
… section Source: PR volcengine#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 volcengine#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.
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
qin-ctx
approved these changes
May 9, 2026
Collaborator
|
nice |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Surface
openclaw openviking status(and its--jsonautomation flag) in the OpenClaw plugin integration'sVerifysection in bothdocs/en/agent-integrations/03-openclaw.mdand thedocs/zh/...mirror.#1904 (LinQiang391, merged 2026-05-08 by qin-ctx) made
openclaw openviking setup/openclaw openviking statusthe canonical CLI surface for the plugin and reworkedINSTALL.md/INSTALL-AGENT.md/INSTALL-ZH.mdaccordingly. The integration doc was not touched in that PR — itsVerifysection still only lists indirect manual checks (slot lookup, log follow, log cat,ov-install --current-version), none of which probe server compatibility or summarise plugin health in one command.What's added
A small additive intro to
Verify(~6 lines per language, before the existing manual checks):openclaw openviking statusas the one-shot health check covering plugin registration, server connectivity, and version compatibility.--jsonautomation note, with the explicit caveat thatsetup --jsonrequires--base-url(the existing CLI rejects baresetup --jsonwith"--json requires --base-url for non-interactive mode", so the docs need to call this out — seeexamples/openclaw-plugin/commands/setup.tsL498).openclaw config get plugins.slots.contextEngine,openclaw logs --follow,cat openviking.log,ov-install --current-version) are kept intact — they still help when debugging individual layers.Source-of-truth references
examples/openclaw-plugin/commands/setup.tsL590-612 —.command("status").description("Show current OpenViking plugin status and connectivity")with.option("--zh", ...),.option("--json", ...). CallsgetStatus(configPath), then either JSON.stringify orprintStatus.examples/openclaw-plugin/commands/setup.tsL444-461 —setupregisters--reconfigure,--zh,--base-url,--api-key,--agent-prefix,--account-id,--user-id,--allow-offline,--force-slot,--json.examples/openclaw-plugin/commands/setup.tsL498 —"--json requires --base-url for non-interactive mode"error.getStatus/checkServiceHealth/formatCompatRangetogether cover registration + connectivity + version-compat — supports the "one-shot health check covering …" wording.What's not changed
INSTALL-AGENT.md("Agent operator guide — for agents driving installation on behalf of a user") which is the authoritative agent-flow reference; this PR doesn't duplicate that content, only adds discoverability for the most direct verify path.## Install via ClawHub (recommended)keeps the interactiveopenclaw openviking setupexample unchanged — the bulk of the doc is human-facing, and the new note is scoped toVerify.Test plan
statuscommand behaviour againstcommands/setup.ts(line numbers above).--json requires --base-urlconstraint exists (setup.ts L498).docs/en/agent-integrations/03-openclaw.mdordocs/zh/...(gh pr list --state open --search openclawreturned 10 unrelated plugin-internal PRs).gpt-5.5 xhightwo-round adversarial review (round 1 needs-attention 0.86 on missing--base-urlcaveat forsetup --json→ reworked → round 2 approve).Codex adversarial review
openclaw openviking setup)" implied agents could append--jsonto baresetupfor automation; in factsetup --jsonrequires--base-url. Could read as a docs-bug nit.status --jsonfor automation" vs "setupalso supports--jsonwhen used with--base-url".If something feels off about the framing or the doc placement, please feel free to close and mark accordingly.