vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-03-16 12:30:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: describe channel setup wizard surface

Browse Source
This commit is contained in:
Peter Steinberger
2026-03-15 16:22:47 -07:00
parent a4047bf148
commit d040d48af4
1 changed files with 22 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/tools/plugin.md
View File

@@ -1373,28 +1373,33 @@ Notes:
- `meta.preferOver` lists channel ids to skip auto-enable when both are configured.
- `meta.detailLabel` and `meta.systemImage` let UIs show richer channel labels/icons.
### Channel onboarding hooks
### Channel setup hooks
Channel plugins can define optional onboarding hooks on `plugin.onboarding`:
Preferred setup split:
- `configure(ctx)` is the baseline setup flow.
- `configureInteractive(ctx)` can fully own interactive setup for both configured and unconfigured states.
- `configureWhenConfigured(ctx)` can override behavior only for already configured channels.
- `plugin.setup` owns account-id normalization, validation, and config writes.
- `plugin.setupWizard` lets the host run the common wizard flow while the channel only supplies status/credential/allowlist descriptors.
Hook precedence in the wizard:
Use `plugin.onboarding` only when the host-owned setup wizard cannot express the flow and the
channel needs to fully own prompting.
1. `configureInteractive` (if present)
2. `configureWhenConfigured` (only when channel status is already configured)
3. fallback to `configure`
Wizard precedence:
Context details:
1. `plugin.setupWizard` (preferred, host-owned prompts)
2. `plugin.onboarding.configureInteractive`
3. `plugin.onboarding.configureWhenConfigured` (already-configured channel only)
4. `plugin.onboarding.configure`
- `configureInteractive` and `configureWhenConfigured` receive:
- `configured` (`true` or `false`)
- `label` (user-facing channel name used by prompts)
- plus the shared config/runtime/prompter/options fields
- Returning `"skip"` leaves selection and account tracking unchanged.
- Returning `{ cfg, accountId? }` applies config updates and records account selection.
`plugin.setupWizard` is best for channels that fit the shared pattern:
- one account picker driven by `plugin.config.listAccountIds`
- one primary credential prompt written via `plugin.setup.applyAccountConfig`
- optional DM allowlist resolution (for example `@username` -> numeric id)
`plugin.onboarding` hooks still return the same values as before:
- `"skip"` leaves selection and account tracking unchanged.
- `{ cfg, accountId? }` applies config updates and records account selection.
### Write a new messaging channel (step‑by‑step)
@@ -1421,7 +1426,7 @@ Model provider docs live under `/providers/*`.
4. Add optional adapters as needed
- `setup` (wizard), `security` (DM policy), `status` (health/diagnostics)
- `setup` (validation + config writes), `setupWizard` (host-owned wizard), `security` (DM policy), `status` (health/diagnostics)
- `gateway` (start/stop/login), `mentions`, `threading`, `streaming`
- `actions` (message actions), `commands` (native command behavior)