mirror of
https://github.com/openclaw/openclaw.git
synced 2026-07-09 15:13:55 +00:00
07bf384a8b
* feat(crestodian): AI-first conversational onboarding with typed-op guardrails Interactive `openclaw onboard` (and bare `openclaw` on a fresh install) now opens the Crestodian conversation: detection-backed first-run proposal (Claude Code/Codex logins, API keys), persona AI turns for every free-form message (configless local-runtime fallback, 60s deadline, deterministic degradation), approval-gated typed operations, chat-hosted channel setup (`connect <channel>`), config get/schema read ops with secret redaction, and a post-write validation hook that feeds schema errors back for a self-fix turn. Adds the additive gateway `crestodian.chat` method so app clients run the same conversation. Classic wizard stays behind --classic/explicit flags; non-interactive automation unchanged; `--modern` becomes a deprecated alias for `openclaw crestodian`. * feat(macos): Crestodian chat onboarding and importance-ordered permissions Replace the gateway step-wizard page with a Crestodian chat over the new crestodian.chat method (works before any model auth exists), sort the permissions page by importance with no scrolling, drop the redundant manual refresh, and bump the onboarding version. * feat(crestodian): run the custodian on the real agent loop with a ring-zero tool Crestodian conversations now execute through the same embedded agent runner as regular agents: a persistent agent session with a single construction-gated `crestodian` tool wrapping the typed operations (read actions free; mutations require approved=true asserted from explicit user consent, audited, with post-write config validation fed back into the loop). The engine prefers the loop (configured models or the Codex app-server fallback) and degrades to the single-turn planner, then to deterministic commands. Setup approval seeds the crestodian exec approval so local model harnesses can run; the configless Codex backend config now enables exec and direct tool loading (it was dead-on-arrival behind tools.exec.mode=deny and the tool-search index). * test(crestodian): type the engine mock signatures for the core test lane * fix(crestodian): map the advertised create_agent tool action * fix(crestodian): host-verified approval arming and a macOS setup completion gate Review findings: the model-supplied approved flag alone could authorize ring-zero mutations (prompt injection / model error), and removing the macOS wizard gate let users Next past the Crestodian page with nothing configured. Mutating tool actions now also require host-verified consent (the engine arms approval only when the user's actual message is an explicit yes), and local macOS onboarding blocks advancing until setup authored the config, using the same signal the old step wizard checked. * fix(crestodian): bind approval to the exact proposed operation and gate dot navigation A generic yes no longer authorizes arbitrary mutations: denied mutating tool calls register a canonical operation fingerprint (host-owned, per session), and an armed turn executes only the identical call, once. The denial message is arming-aware so the approved turn self-heals in one roundtrip, and the agent protocol pre-registers proposals. macOS onboarding page dots now honor the same setup-completion gate as the Next button. * fix(crestodian): redact sensitive wizard answers, skip logged-out CLIs, gate programmatic advance Sensitive channel-wizard answers (tokens, passwords) are redacted from the AI-visible conversation history; setup and the onboarding welcome never pick or advertise a definitively logged-out CLI as the model; and macOS handleNext() honors the page gates for programmatic callers (chat handoff) just like the Next button. * fix(crestodian): align the onboarding welcome's configured predicate with the app gate A valid config carrying only a default model (partial/hand-written) now still gets the first-run proposal instead of the ready guide, so the macOS setup gate can always be satisfied from the conversation. * fix(crestodian): armed turns can never mint their own executable proposal An approval-mismatched call inside an armed turn no longer re-registers and invites a retry (which let the model swap the approved operation for another in the same turn); it voids the approval entirely and requires a fresh yes. Proposals register only in unarmed turns, which the agent protocol already does when proposing. * fix(onboard): route any explicit setup flag to the classic wizard * fix(ci): satisfy new lint rules, tool-display guard, and generated artifacts for crestodian * chore(i18n): refresh native inventory after permissions copy wrap * fix(crestodian): harden conversational onboarding * docs(crestodian): document conversational onboarding * test(crestodian): type embedded runner mock * fix(crestodian): close onboarding security gaps * chore: retrigger ci
summary, read_when, title
| summary | read_when | title | |||
|---|---|---|---|---|---|
| Repository script entry points and compatibility notes |
|
Scripts Directory |
Scripts Directory
The scripts/ directory contains repository tooling used by local development,
CI, docs publishing, releases, Docker proof, and maintainer operations. Prefer
the package-script entry points in package.json when one exists, then read the
underlying script before running it directly.
Compatibility
Many scripts are stable paths referenced by package.json, GitHub Actions,
docs, and maintainer runbooks. Do not move, rename, or regroup scripts only to
improve taxonomy. A directory migration needs an explicit maintainer-approved
compatibility plan for package scripts, workflows, docs snippets, and any raw
script paths users may have copied.
This index is a discovery aid for the current flat layout. It does not define a new directory taxonomy.
Common Entry Points
| Area | Prefer | Notes |
|---|---|---|
| Build | pnpm build |
Runs scripts/build-all.mjs; use specific build scripts only when debugging a build stage. |
| Changed checks | pnpm changed:lanes --json, pnpm check:changed |
Lane classification lives in scripts/changed-lanes.mjs; changed-file checks live in scripts/check-changed.mjs. |
| Docs | pnpm docs:list, pnpm docs:check-mdx, pnpm docs:check-links |
Backed by scripts/docs-list.js, scripts/check-docs-mdx.mjs, and scripts/docs-link-audit.mjs. |
| Formatting docs | pnpm format:docs:check |
Uses scripts/format-docs.mjs; use write mode only when intentionally formatting docs. |
| Lint | pnpm lint, pnpm lint:core, pnpm lint:all |
Wrapper scripts keep oxlint behavior aligned with repo config. |
| Targeted tests | pnpm test <path-or-filter> or node scripts/run-vitest.mjs <path-or-filter> |
Avoid bare vitest; it can start watch mode. |
| Changed tests | pnpm test:changed |
Uses the repo's changed-test resolver instead of a broad Vitest run. |
| Docker proof | pnpm test:docker:all, pnpm test:docker:rerun, pnpm test:docker:timings |
Use the planner/rerun helpers before launching broad Docker work. |
| Live proof | pnpm test:live |
Live checks require the matching environment and credentials. |
| Release checks | pnpm release:check, pnpm release:beta, pnpm release:candidate |
Release scripts are maintainer workflows; read release docs before use. |
| GitHub reads | scripts/gh-read |
Uses a GitHub App read token when configured, leaving normal gh login for writes. |
| Commits | scripts/committer "<message>" <files...> |
Preferred scoped commit helper for OpenClaw changes. |
| Remote proof | node scripts/crabbox-wrapper.mjs ... |
Use for Crabbox/Testbox lanes when local proof would be too broad or environment-sensitive. |
Script Families
check-*.mjs/check-*.ts: guardrails for architecture, docs, package contents, boundaries, workflows, and generated artifacts.run-*.mjs: wrappers around repo runtimes or tools, such as Node, Vitest, oxlint, tsgo, and environment setup.test-*.mjs/test-*.sh/test-*.ts: test planners, Docker lanes, live checks, and focused validation helpers.docs-*andcheck-docs-*: docs listing, link auditing, MDX checks, spellcheck, sync, and i18n glossary checks.release-*,openclaw-npm-*, andplugin-*-release-*: release preparation, package verification, and publishing helpers.docker-*,test-docker-*, andtest-live-*-docker.sh: Docker E2E planning, rerun, timing, and live/package lane helpers.gh-read*,label-*,sync-labels.ts, and PR helpers: GitHub read, labeling, and maintainer workflow support.generate-*,write-*,copy-*, andsync-*: generated docs, metadata, package surfaces, and build artifact support.lib/: shared helpers imported by script entry points.
Maintenance Rules
- Read
scripts/AGENTS.mdbefore changing scripts. - Keep package scripts, generators, generated-artifact checks, docs references, and workflow references aligned when touching a script path.
- Prefer existing wrappers instead of introducing a raw tool invocation.
- Add or update focused tests under
test/scripts/when changing script behavior.
See also Scripts for public-facing script guidance.