mirror of https://github.com/openclaw/openclaw.git synced 2026-10-03 01:29:56 +00:00

mirror of github.com/openclaw/openclaw https://openclaw.ai

ai assistant crustacean molty openclaw own-your-data personal

Find a file

Alix-007 a15ebf6969 fix(doctor): surface directory inspection failures (#147287 ) ## What Problem This Solves CLI health diagnostics silently treat every failed directory metadata lookup as an absent directory. A cyclic project-directory symlink, an inaccessible workspace, or a file blocking a parent component can consequently produce no directory warning. ## Why This Change Was Made Keep only `ENOENT` on the existing quiet missing-directory path. Other `statSync` failures use the existing unreadable-directory diagnostic and repair guidance, through the shared errno helper. Successful regular-file and read/write checks remain unchanged. This is independent of the configuration-root work in #145895: it does not change directory selection, authentication, backend registration, transcript lookup, or persistence. ## User Impact Operators receive a directory warning instead of silence when the configured CLI workspace/project metadata cannot be inspected. Healthy directories and genuinely absent first-use directories remain quiet. Doctor does not create, repair, remove, or change permissions on any directory in this patch; update execution and rollback behavior are unchanged. ## Evidence ### Historical September 14 integration refresh Refresh head: `1e4d36ce602446a2821aea6fa2e4be1a17a17f9e`. Original branch head `4b256621d378b969f52c3c7fb1aa1479df656384` and pinned main ``8b917bc499`` are both preserved as parents; no force-push. Refresh the existing accepted patch onto pinned main to remove stale integration inputs and obtain new-head CI. No new feature or unrelated failure workaround is added. The resulting tree exactly matches the conflict-free git merge-tree result; there are no manual source or test edits. Validation on Linux / Node 26.1.0 with frozen-lockfile dependencies: No new local runtime test is claimed for this mechanical integration; existing proof keeps its original revision and exact-head hosted CI is required. The native staged-content/format guard, main-relative diff check, and one fresh independent P0-P2 source review passed. No full build or full type-aware check was rerun locally; new-head CI is tracked separately. Earlier runtime proof below retains its recorded SHA; it is not relabeled as a new execution. Candidate: `4b256621d378b969f52c3c7fb1aa1479df656384`, based on ``e9c1cb7e71``. Linux, Node 26.1.0; isolated synthetic HOME/config/state and a physically independent dependency installation. The production file was rechecked against current main ``0e4b4d1fa3``; its metadata catch still has the same defect. ### Observed directory diagnostics The source-runtime driver imports the actual `<directory-health-owner>` entry and project-directory resolver through `scripts/tsx.mjs`. It creates a real cyclic project symlink (`ELOOP`) and a real file-parent/child path (`ENOTDIR`), captures the entry's note output, and checks real filesystem contents afterwards. No filesystem result or directory-health function is mocked. Only the external CLI executable is a synthetic executable returning a logged-in status; the production auth subprocess launches it normally. ```sh node --import ./scripts/tsx.mjs <proof-driver> "$PWD" baseline node --import ./scripts/tsx.mjs <proof-driver> "$PWD" candidate ``` \| Same native filesystem scenario \| Before \| After \| \| --- \| --- \| --- \| \| Cyclic project-directory symlink \| No note \| Project directory is not readable; existing repair hint \| \| Workspace below a regular-file parent \| No note \| Workspace is not readable; existing repair hint \| \| Healthy directory \| No note \| No note \| \| Missing workspace \| No note \| No note \| Actual candidate output, with temporary paths redacted: ```text - <backend> project dir: <isolated-home>/.<backend>/projects/<workspace-key> is not readable by this user. - Fix: make the <backend> project dir readable, or remove the broken path and let <backend> recreate it. - Workspace: <fixture>/file-parent/child is not readable by this user. - Fix: make the workspace a readable, writable directory for the gateway user. ``` Both driver runs recorded exactly four `auth status --json` fixture invocations, unchanged configuration/executable/blocking-file bytes, and successful scratch removal. Candidate production SHA-256 `c3eac4e054ffdd415b4b35fd3e55aee3e492a25bcde62ecc0beb26ffd8ff2075` remained unchanged during proof and matches the committed file. The unbuilt source checkout emitted bundled backend setup-entry loading warnings and used the unchanged default CLI-command fallback. This is directory-owner proof with a real subprocess fixture, not verification of bundled backend discovery, installed Doctor bootstrap, a real account, an updater, or model execution. The warnings were retained rather than counted as successful plugin loading. ### Historical repository validation - Baseline existing-suite run: 9 passed / 5 failed. Four metadata-error cases observed zero notes, and the real blocked-parent case also observed no note. The candidate uses the existing unreadable wording for an unresolvable child, without claiming the child exists. - Candidate `node scripts/run-vitest.mjs src/commands/doctor-<backend>-cli.test.ts --reporter=json --outputFile=<receipt>`: 14/14 passed. Existing tests are retained; new cases cover EACCES, EPERM, EIO, ELOOP, actual ENOTDIR and a missing-path control. - `node scripts/run-oxlint.mjs --tsconfig config/tsconfig/oxlint.core.json src/commands/doctor-<backend>-cli.ts src/commands/doctor-<backend>-cli.test.ts`: 2 files, 263 rules, zero warnings/errors. - Changed-file `oxfmt` and the normal formatting commit hook passed without changing the proof-covered production bytes. - One fresh independent P0–P2 autoreview of the staged diff: scoped-clean, no actionable findings. The reviewer did not rerun tests or builds. The historical execution above does not claim a full build, full typecheck, Windows execution, published-updater test or all-green hosted CI. There are no new configuration keys, public APIs, stored formats, log policies or dependencies. The production change is confined to classifying an existing diagnostic failure. --- ## Current validation at 937d7f2a The contributor commits and refresh remain intact. One additional commit replaces the helper-only regression cases with registered Doctor dispatch tests. The historical results above retain their original identities; the following evidence describes the current head. Backend names and local proof locations are generalized for publication. ## Problem and fix Doctor could silently omit its directory-health warning for an unreadable or cyclic project directory. Only an absent path now stays quiet after a failed metadata lookup; other failures reach the existing warning and repair guidance. ## Impact Readable and first-use paths stay quiet. Directory contents and permissions are unchanged. The contributor's production fix and authorship are retained; the correction changes only tests. ## Evidence At `937d7f2a5e6c830782164c3453efea77c8556367`, isolated `pnpm openclaw doctor --non-interactive` runs deliver warnings and matching hints for native cyclic, permission-denied and blocked-parent paths. Readable/missing controls stay quiet; regular-file behavior is unchanged. The structured cyclic check returns one warning and exit 1. Registered dispatch tests fail for both broken directories on main ``8b917bc499`` and pass on the correction. The owner plus three Doctor sibling files pass 213 tests. The required local type-aware preflight passes. Hosted CI run [34807143893](https://github.com/openclaw/openclaw/actions/runs/34807143893) passed at this exact head after one retry of a shutdown-timing test group. The same group passed locally on the head and plain main (172 tests). Historical captures remain attributed separately: original candidate `4b256621`, historical merge `193a40f08164`, and their recorded main baselines. The merge's 214-test record was recovered without rerunning it; its real CLI matrix now has matching source/build identities. ## Consumers Normal Doctor output and structured findings share the corrected directory-health owner. Directory selection, authentication and transcript readers are unchanged. Tests exercise registered dispatch, runtime selection and final warning delivery, with readable/missing controls. AI-assisted. Co-authored-by: Ayaan Zaidi <hi@obviy.us>		2026-09-14 11:07:00 +05:30
.agents
.claude
.github	refactor(ui): model Workboard preview sessions consistently (#144747 )	2026-09-13 17:11:33 -03:00
.vscode
apps	chore(i18n): refresh native locales (#147899 )	2026-09-14 05:07:29 +00:00
CHANGELOG
config	refactor(configure): dispatch validated sections directly (#147691 )	2026-09-13 22:32:59 -07:00
custodian-skills
deploy
docs	fix(memory): preserve indexing retries during redaction changes (#147870 )	2026-09-13 22:29:31 -07:00
examples/ai-chat
extensions	fix(memory): preserve indexing retries during redaction changes (#147870 )	2026-09-13 22:29:31 -07:00
git-hooks
packages	fix(memory): preserve indexing retries during redaction changes (#147870 )	2026-09-13 22:29:31 -07:00
patches
qa	feat(subagents): allow private parent completion handoffs (#147206 )	2026-09-13 16:09:47 -06:00
scripts	fix(update): explain invalid config during database preflight (#147771 )	2026-09-13 22:16:54 -07:00
security
skills	fix(skills): keep sag available with alternate credentials (#147685 )	2026-09-14 08:26:59 +05:30
src	fix(doctor): surface directory inspection failures (#147287 )	2026-09-14 11:07:00 +05:30
test	fix(ci): skip SDK rendering for identical revisions (#147572 )	2026-09-14 12:54:46 +08:00
ui	fix(ui): prevent Control UI hangs on malformed progress content (#147528 )	2026-09-14 02:35:35 -03:00
.crabbox.yaml
.dockerignore
.env.example
.gitattributes
.gitignore
.npmrc
.oxfmtrc.jsonc
.oxlintrc.json
.pre-commit-config.yaml
.semgrepignore
AGENTS.md
appcast.xml
CHANGELOG.md
CLAUDE.md
CONTRIBUTING.md
docker-compose.yml
Dockerfile
fly.toml
LICENSE
node-runtime-recovery.d.mts
node-runtime-recovery.mjs
node-runtime-update.d.mts
node-runtime-update.mjs
node-sqlite.d.mts
node-sqlite.mjs
node-version.d.mts
node-version.mjs
openclaw.mjs
package.json	test(e2e): retire obsolete plugin staging smoke (#147555 )	2026-09-14 12:30:54 +08:00
pnpm-lock.yaml	fix: restore plugin networking under Bun (#147421 )	2026-09-13 19:25:19 -07:00
pnpm-workspace.yaml	fix(codex): isolate hook imports and cancel disconnected waits (#147444 )	2026-09-14 07:14:04 +08:00
README.md	docs: alphabetize donors and sponsors and add Red Hat logo (#147302 )	2026-09-13 17:27:18 -04:00
render.yaml
SECURITY.md
taxonomy.yaml
THIRD_PARTY_NOTICES.md
tsconfig.core.json
tsconfig.extensions.json
tsconfig.extensions.projects.json
tsconfig.json	refactor(paths): centralize home directory resolution (#145866 )	2026-09-13 18:58:17 -07:00
tsconfig.scripts.json
tsconfig.ui.json
tsdown.ai.config.ts
tsdown.config.ts	fix(setup): resume interrupted setup in the approved workspace (#147705 )	2026-09-14 10:43:12 +08:00
VISION.md
vitest.config.ts

README.md

OpenClaw 🦞 — Your assistant, on your devices, in your chats

OpenClaw is an open-source AI assistant that runs on your own computer and meets you in the channels you already use: Discord, iMessage, Slack, Teams, Telegram, WhatsApp, and 20+ more, plus native apps for macOS, iOS, Android, Windows, and Linux. One Gateway runs it as a personal assistant on a laptop or as a shared team deployment; configuration is the only difference.

Yours, with no catch. State, memory, and credentials live on your hardware. Models and agent harnesses (Claude, Codex, local models) are plugins you can swap without changing anything else. Your prompts go to the model provider and chat platforms you configure, plus any diagnostics export you enable yourself; by default OpenClaw itself phones home for nothing but a daily version check, anonymous feature statistics are opt-in, and update.checkOnStart: false disables both (what OpenClaw sends). OpenClaw is stewarded by the OpenClaw Foundation, an independent 501(c)(3), and has no paid tier, hosted service, or token. The architecture case — trusted gateway, untrusted execution, deterministic policy — is in Why OpenClaw.

Website · Docs · Getting started · Why OpenClaw · Showcase · FAQ · Vision · DeepWiki

Install

The installer supports macOS, Linux, and Windows. It provisions a supported Node.js runtime when needed.

# macOS / Linux / WSL2
curl -fsSL https://openclaw.ai/install.sh | bash

# Windows PowerShell
iwr -useb https://openclaw.ai/install.ps1 | iex

Already manage Node.js? Install the published package instead (Node 24.16+ or 26.1+; Node 26 recommended):

npm install -g openclaw@latest --allow-scripts=openclaw

That command is for npm 12 or npm 11.16+. On npm 11.15 and earlier, omit --allow-scripts=openclaw. See the installation guide for the lifecycle script contract, Docker, Nix, and other deployment paths.

Quick start

On a fresh install, the installer scripts start onboarding automatically. Complete the wizard they open. If you installed the package directly with npm, pnpm, or Bun, run:

openclaw onboard --install-daemon

After onboarding:

openclaw gateway status
openclaw dashboard

Onboarding verifies model access, creates the workspace, and configures the Gateway. The last command opens the Control UI; send a message there to confirm the assistant is working. See the getting started guide for channel setup and troubleshooting.

How it fits together

The Gateway is the local control plane for sessions, tools, events, and channel connections.
The Control UI, CLI, and TUI connect to the Gateway.
Channels bring the assistant to WhatsApp, Telegram, Slack, Discord, Google Chat, Signal, iMessage, and other messaging services.
Companion apps and nodes add voice, Canvas, camera, screen, and device-local actions on supported platforms.

OpenClaw works with hosted and local model providers. Its tools, skills, and plugins extend what an assistant can do.

Security

Treat inbound messages as untrusted input. DM-capable channels pair unknown senders by default; approve a pairing request with openclaw pairing approve <channel> <code>.

Tools run on the host for the main session unless you configure sandboxing. Read the security guide, exposure runbook, and sandboxing guide before connecting other users or exposing the Gateway remotely.

Documentation

Goal	Start here
Configure models and auth	Models · Model providers
Connect a messaging service	Channels
Add tools, skills, and plugins	Tools · Skills · Plugins · ClawHub
Run apps and device nodes	Platforms · Nodes
Use the CLI and chat commands	CLI reference · Slash commands
Configure or operate the Gateway	Configuration · Architecture · Updating · Release channels

Development

The repository is a pnpm workspace. Plain npm install at the repository root is not supported.

git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install
pnpm build
pnpm ui:build

See CONTRIBUTING.md for the contribution workflow and the source setup guide for the development loop.

Governance

OpenClaw is developed in the open by the OpenClaw Foundation, an independent 501(c)(3). The Foundation employs the core team and signs releases. Donors and infrastructure sponsors support the Foundation; none of them own or direct the project. OpenAI is a donor, not an owner.

Community

See CONTRIBUTING.md for maintainers and contribution guidelines; AI-assisted PRs are welcome.

Use the issue chooser for bugs and feature requests, ask setup questions in Discord, and report vulnerabilities through SECURITY.md. New capabilities usually belong in plugins built on the plugin SDK and shared through ClawHub.

OpenClaw was built for Molty, a space lobster AI assistant, by Peter Steinberger and the community. Explore the project lore, soul.md, Peter's site, Star History, and @openclaw.

Special thanks to Mario Zechner for his support and for pi, and to Adam Doppelt for the lobster.bot domain.

Donors and sponsors

The Foundation is funded by donors including Amazon, Lobster Computer Company, Offline Holdings, OpenAI, Red Hat, and the University of Michigan, with infrastructure support from Blacksmith, Convex, GitHub, NVIDIA, and Vercel.