docs: add 'xclawrouter setup' step after each OpenClaw install path#6
Merged
Conversation
Before this, only the curl one-liner included the OKX wallet onboarding prompt (via scripts/reinstall.sh's "Next step" block). Users following Options 2 (`openclaw plugins install`) or 3 (`npm install -g`) saw the plugin install succeed with zero indication that anything else was needed. Net effect: the gateway restarted, the plugin loaded, OKX detection failed (no session), the OnchainOsRequiredError was logged to the gateway's file log where no user looks, and BlockRun models silently didn't work in OpenClaw. The plugin can't easily prompt the user from inside the gateway daemon (no TTY, no stdin), so the README is the right surface to make this explicit. Each Option now ends with a `xclawrouter setup` line. Also reworded the trailing paragraph: dropped the "On first run XClawRouter prompts you to log in..." sentence — that auto-prompt only fires when the user runs `npx @blockrun/xclawrouter` standalone in an interactive TTY, not on the OpenClaw plugin path, so it was misleading in this context.
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
1 participant
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.
Why
Only the curl one-liner (Option 1) included the OKX wallet onboarding prompt — via the `Next step` block in scripts/reinstall.sh & scripts/update.sh (PRs #3 and #5).
Users following Option 2 (`openclaw plugins install`) or Option 3 (`npm install -g`) saw the plugin install succeed with zero indication that anything else was needed. Net effect:
Reproduced live just now:
```
$ openclaw plugins install @blockrun/xclawrouter
Installed plugin: xclawrouter
Restart the gateway to load plugins.
$ openclaw gateway restart
22:52:46 [restart] killing 1 stale gateway process(es)...
Restarted LaunchAgent: gui/501/ai.openclaw.gateway
$ # user has no idea what to do next
```
The plugin can't easily prompt the user from inside the gateway daemon (no TTY, no stdin), so the README is the right surface to make this explicit.
What
Each install Option now ends with a `xclawrouter setup` line:
```bash
Option 1
curl ... | bash
openclaw gateway restart
npx @blockrun/xclawrouter setup # ← added
Option 2
openclaw plugins install @blockrun/xclawrouter
openclaw gateway restart
npx @blockrun/xclawrouter setup # ← added
Option 3
npm install -g @blockrun/xclawrouter
openclaw gateway restart
xclawrouter setup # ← added (binary on PATH after -g install)
```
Also reworded the trailing paragraph: dropped "On first run XClawRouter prompts you to log in..." — that auto-prompt only fires when the user runs `npx @blockrun/xclawrouter` standalone in an interactive TTY, not on the OpenClaw plugin path, so it was misleading.
Test plan