fix: honor OPENCLAW_HOME defaults by giodl73-repo · Pull Request #85802 · openclaw/openclaw

giodl73-repo · 2026-05-23T18:59:51Z

Summary

Make the default dev checkout path honor the existing OPENCLAW_HOME contract when OPENCLAW_GIT_DIR is not set.
Align install.sh and install-cli.sh defaults for git checkout, CLI prefix, installer onboarding workspace, and legacy config checks with OPENCLAW_HOME while preserving explicit overrides.
Update environment/install docs and add regression tests for fresh custom-home clone parents and installer defaults.

Verification

OPENCLAW_VITEST_MAX_WORKERS=1 OPENCLAW_VITEST_NO_OUTPUT_TIMEOUT_MS=900000 CI=1 node scripts/run-vitest.mjs src/cli/update-cli.test.ts test/scripts/install-sh.test.ts test/scripts/install-cli.test.ts src/infra/home-dir.test.ts src/config/paths.test.ts src/agents/agent-scope.test.ts
git diff --check HEAD~1 HEAD
bash -n scripts/install.sh scripts/install-cli.sh
corepack pnpm exec oxfmt --check --threads=1 CHANGELOG.md src/cli/update-cli/shared.ts src/cli/update-cli.test.ts test/scripts/install-sh.test.ts test/scripts/install-cli.test.ts docs/help/environment.md docs/cli/update.md docs/install/installer.md docs/install/development-channels.md
corepack pnpm exec oxlint src/cli/update-cli/shared.ts src/cli/update-cli.test.ts test/scripts/install-sh.test.ts test/scripts/install-cli.test.ts
codex review --base origin/main -> no actionable regressions
Testbox through Crabbox: provider blacksmith-testbox, id tbx_01ksb14y96m92ymhqsnh82gf32, Actions run https://github.com/openclaw/openclaw/actions/runs/26340143430, command pnpm check:changed, exit 0

Real behavior proof

Behavior addressed: OPENCLAW_HOME is no longer ignored by default dev checkout, installer onboarding, and CLI installer path defaults when explicit path overrides are absent.

Real environment tested: WSL Ubuntu 24.04 durable checkout, branch fix-54014-openclaw-home-paths, local head 3b0d64eae6dbd0968d4252bcc7017408bdf046c8; broad validation on Blacksmith Testbox through Crabbox.

Exact steps or command run after this patch: focused Vitest command above, shell syntax check, format/lint checks, Codex review, and Testbox pnpm check:changed via node scripts/crabbox-wrapper.mjs run --provider blacksmith-testbox ....

Evidence after fix: regression tests prove resolveGitInstallDir() uses $OPENCLAW_HOME/openclaw, creates the fresh custom-home parent before clone, install.sh uses $OPENCLAW_HOME for git/workspace/onboarding defaults, and install-cli.sh uses $OPENCLAW_HOME for default prefix/git paths.

Observed result after fix: 7 focused test files passed with 291 tests; local static checks passed; Codex review found no actionable regressions; Testbox pnpm check:changed passed with exit 0.

What was not tested: a live package install/update against an installed production OpenClaw binary was not executed; behavior is covered by path/default regression tests plus the changed-gate Testbox run.

2026-05-23 update

Addressed the ClawSweeper blockers after rebasing onto current origin/main:

Kept scripts/install-cli.sh default install prefix at $HOME/.openclaw; OPENCLAW_HOME still controls the local git checkout and related OpenClaw home paths.
Made bootstrap onboarding skip when a legacy $HOME/.openclaw/openclaw.json or $HOME/.clawdbot/clawdbot.json exists and OPENCLAW_CONFIG_PATH is not explicit, so existing installs are not prompted again after setting OPENCLAW_HOME.
Added focused regression coverage for the install CLI prefix split and legacy-home onboarding compatibility.

Validation:

$ node scripts/run-vitest.mjs src/cli/update-cli.test.ts test/scripts/install-cli.test.ts test/scripts/install-sh.test.ts --reporter=verbose
Test Files  3 passed (3)
Tests  156 passed (156)

$ ./node_modules/.bin/oxfmt --check --threads=1 CHANGELOG.md docs/cli/update.md docs/help/environment.md docs/install/development-channels.md docs/install/installer.md scripts/install-cli.sh scripts/install.sh src/cli/update-cli.test.ts src/cli/update-cli/shared.ts test/scripts/install-cli.test.ts test/scripts/install-sh.test.ts && git diff --check
passed

Installer behavior proof from temp dirs using the sourced installer paths:

# OPENCLAW_HOME compatibility proof
$ source scripts/install.sh with OPENCLAW_HOME and legacy HOME config
workspace=/tmp/tmp.IGQTmlr4rz/oc-home/.openclaw/workspace
onboarding_status=0
$ source scripts/install-cli.sh with OPENCLAW_HOME and no OPENCLAW_PREFIX
prefix=/tmp/tmp.IGQTmlr4rz/home/.openclaw
git=/tmp/tmp.IGQTmlr4rz/oc-home/openclaw

This exercises the installer functions directly without doing a network package install.

2026-05-23 ShellCheck update

Fixed the installer tilde-match patterns flagged by Website Installer Sync ShellCheck (SC2088) by using escaped literal \~ patterns for OPENCLAW_HOME values such as ~/....

Validation after this patch:

$ shellcheck -e SC1091 scripts/install.sh scripts/install-cli.sh
passed

$ node scripts/run-vitest.mjs src/cli/update-cli.test.ts test/scripts/install-cli.test.ts test/scripts/install-sh.test.ts --reporter=verbose
Test Files  3 passed (3)
Tests  156 passed (156)

$ ./node_modules/.bin/oxfmt --check --threads=1 CHANGELOG.md docs/cli/update.md docs/help/environment.md docs/install/development-channels.md docs/install/installer.md scripts/install-cli.sh scripts/install.sh src/cli/update-cli.test.ts src/cli/update-cli/shared.ts test/scripts/install-cli.test.ts test/scripts/install-sh.test.ts && git diff --check
passed

CI note: the prior run also showed shared unrelated failures in check-lint, check-test-types, and check-additional-extension-bundled that do not point at this PR's files, plus a gateway runtime shard no-output timeout.

clawsweeper · 2026-05-23T19:01:31Z

Codex review: needs maintainer review before merge.

Latest ClawSweeper review: 2026-05-24 03:05 UTC / May 23, 2026, 11:05 PM ET.

Workflow note: Future ClawSweeper reviews update this same comment in place.

How this review workflow works

ClawSweeper keeps one durable marker-backed review comment per issue or PR.
Re-runs edit this comment so the latest verdict, findings, and automation markers stay together instead of adding duplicate bot comments.
A fresh review can be triggered by eligible @clawsweeper re-review comments, exact-item GitHub events, scheduled/background review runs, or manual workflow dispatch.
PR/issue authors and users with repository write access can comment @clawsweeper re-review or @clawsweeper re-run on an open PR or issue to request a fresh review only.
Maintainers can also comment @clawsweeper review to request a fresh review only.
Fresh-review commands do not start repair, autofix, rebase, CI repair, or automerge.
Maintainer-only repair and merge flows require explicit commands such as @clawsweeper autofix, @clawsweeper automerge, @clawsweeper fix ci, or @clawsweeper address review.
Maintainers can comment @clawsweeper explain to ask for more context, or @clawsweeper stop to stop active automation.

PR Surface
Source +2, Tests +162, Docs +7, Other +54. Total +225 across 11 files.

View PR surface stats

Area	Files	Added	Removed	Net
Source	1	3	1	+2
Tests	3	167	5	+162
Docs	5	40	33	+7
Config	0	0	0	0
Generated	0	0	0	0
Other	2	65	11	+54
Total	11	275	50	+225

Summary
The PR makes update-cli and installer git/onboarding defaults honor OPENCLAW_HOME when explicit path overrides are absent, while keeping the CLI install prefix under the OS home by default.

Reproducibility: yes. at source level: current main derives the update dev checkout from os.homedir() and installer git/workspace/config defaults from HOME when OPENCLAW_HOME is set. The PR tests cover the failing default-path cases directly.

PR rating
Overall: 🐚 platinum hermit
Proof: 🐚 platinum hermit
Patch quality: 🐚 platinum hermit
Summary: The PR is a good normal bug fix with focused implementation and sufficient terminal proof, with only maintainer-owned upgrade-risk review remaining.

Rank-up moves:

Run one live install/update smoke with OPENCLAW_HOME set and legacy HOME config if maintainers want stronger upgrade proof before merge.

What the crustacean ranks mean

🦀 challenger crab: rare, exceptional readiness with strong proof, clean implementation, and convincing validation.
🦞 diamond lobster: very strong readiness with only minor maintainer review expected.
🐚 platinum hermit: good normal PR, likely mergeable with ordinary maintainer review.
🦐 gold shrimp: useful signal, but proof or patch confidence is still limited.
🦪 silver shellfish: thin signal; proof, validation, or implementation needs work.
🧂 unranked krab: not merge-ready because proof is missing/unusable or there are serious correctness or safety concerns.
🌊 off-meta tidepool: rating does not apply to this item.

Shiny media proof means a screenshot, video, or linked artifact directly shows the changed behavior. Runtime, network, CSP, and security claims still need visible diagnostics.

Real behavior proof
Sufficient (terminal): The PR body includes terminal proof from WSL temp-dir installer runs plus focused tests and a Blacksmith Testbox pnpm check:changed run; a full live package install/update remains untested.

Risk before merge

Merging changes the default dev checkout and onboarding workspace paths for users who set OPENCLAW_HOME without explicit path overrides, so existing HOME-based layouts may stop being reused by default.
The proof covers focused tests, sourced installer shell behavior, static checks, and Testbox changed checks, but not a full live package install/update against an installed production binary.
The protected maintainer label means the compatibility-sensitive installer/default-path change needs explicit maintainer handling before merge.

Maintainer options:

Run one upgrade smoke (recommended)
Before merge, run one latest-head install/update smoke with OPENCLAW_HOME set and a legacy HOME config to confirm the intended default split in a real upgrade-like setup.
Accept the focused proof
Maintainers can accept the added regression tests, shell proof, and Testbox changed check as sufficient because the change is path derivation rather than package download behavior.
Pause for installer owner review
If the HOME versus OPENCLAW_HOME split is still a product concern, pause the PR until the installer owner confirms the upgrade contract.

Next step before merge
The PR has no narrow repair finding for ClawSweeper to fix; the remaining action is maintainer review of a protected, compatibility-sensitive installer/default-path change.

Security
Cleared: The diff touches installer scripts, docs, and tests but does not add dependencies, workflow permissions, secret handling, downloaded executables, or new third-party code execution paths.

Review details

Best possible solution:

Land the bounded OPENCLAW_HOME repair after maintainer review, with explicit overrides still authoritative and the HOME-based CLI prefix split preserved; a single upgrade smoke would retire the remaining compatibility uncertainty.

Do we have a high-confidence way to reproduce the issue?

Yes, at source level: current main derives the update dev checkout from os.homedir() and installer git/workspace/config defaults from HOME when OPENCLAW_HOME is set. The PR tests cover the failing default-path cases directly.

Is this the best way to solve the issue?

Yes, with merge-safety review: the patch uses the existing TypeScript home resolver for update-cli and bounded shell helpers for installers while preserving explicit overrides and the HOME-based CLI prefix. The safer remaining step is validation of upgrade behavior, not a different code direction.

Label justifications:

P2: This is a normal-priority bug fix for installer/update defaults with bounded CLI and script blast radius.
merge-risk: 🚨 compatibility: The PR intentionally changes default checkout and onboarding paths for users with OPENCLAW_HOME, which can alter existing upgrade behavior when overrides are absent.
merge-risk: 🚨 session-state: The onboarding workspace/default home location moves under OPENCLAW_HOME, so existing workspace state can be bypassed unless the upgrade split is understood.
rating: 🐚 platinum hermit: Current PR rating is 🐚 platinum hermit because proof is 🐚 platinum hermit, patch quality is 🐚 platinum hermit, and The PR is a good normal bug fix with focused implementation and sufficient terminal proof, with only maintainer-owned upgrade-risk review remaining.
status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Sufficient (terminal): The PR body includes terminal proof from WSL temp-dir installer runs plus focused tests and a Blacksmith Testbox pnpm check:changed run; a full live package install/update remains untested.
proof: sufficient: Contributor real behavior proof is sufficient. The PR body includes terminal proof from WSL temp-dir installer runs plus focused tests and a Blacksmith Testbox pnpm check:changed run; a full live package install/update remains untested.

What I checked:

current main update default: On current main, resolveDefaultGitDir() calls os.homedir() directly, so OPENCLAW_HOME does not affect the default dev checkout path. (src/cli/update-cli/shared.ts:143, 841cb121fb70)
current main installer defaults: On current main, scripts/install.sh derives the default git checkout and onboarding workspace/config checks from HOME, not OPENCLAW_HOME. (scripts/install.sh:1027, 841cb121fb70)
PR head update-cli repair: The PR head switches update-cli default git-dir resolution to resolveRequiredHomeDir() and creates the parent directory before cloning a missing default checkout. (src/cli/update-cli/shared.ts:145, f974ddd44276)
PR head installer repair: The PR head adds shell-side effective-home resolution, uses it for install-cli.sh git defaults, and uses it for install.sh git and onboarding workspace defaults while preserving the HOME-based install prefix. (scripts/install-cli.sh:32, f974ddd44276)
regression coverage: The PR adds focused tests for OPENCLAW_HOME default checkout resolution, clone parent creation, installer git/workspace defaults, install-cli prefix split, and legacy HOME config onboarding compatibility. (src/cli/update-cli.test.ts:5506, f974ddd44276)
release/current-main provenance: The PR head is not contained in any local release tag or branch, and the latest release tag inspected is v2026.5.22 at a374c3a5bfd5225ce319bce3865aab6216309c4f, so the repair is not already shipped or on current main. (f974ddd44276)

Likely related people:

steipete: Blame and path history in this checkout attribute the current installer/update-cli default-path surfaces and the shared OPENCLAW_HOME resolver to 12f82270cf07db0e37a504e218237e2f58ea6371; the same author also has the most recent touch on update-cli shared code. (role: recent area contributor; confidence: high; commits: 12f82270cf07, 459cee53153c; files: scripts/install.sh, scripts/install-cli.sh, src/cli/update-cli/shared.ts)

Codex review notes: model gpt-5.5, reasoning high; reviewed against 841cb121fb70.

clawsweeper · 2026-05-23T19:10:43Z

ClawSweeper PR egg

✨ Hatched: 🥚 common Neon Diff Drake

Hatch command

Comment @clawsweeper hatch when this PR is hatchable.

Hatchability rules:

Merged PRs are hatchable.
Open PRs are hatchable when they are status: 👀 ready for maintainer look, status: 🚀 automerge armed, or labeled clawsweeper:automerge.
Closed unmerged PRs are hatchable only when one of those hatchable labels is still present in the durable record.

Rarity: 🥚 common.
Trait: sniffs out flaky tests.
Image traits: location flaky test forest; accessory commit compass; palette coral, mint, and warm cream; mood watchful; pose pointing at a small proof artifact; shell matte ceramic shell; lighting calm overcast light; background little resolved-comment flags.
Share on X: post this hatch
Copy: My PR egg hatched a 🥚 common Neon Diff Drake in ClawSweeper.

What is this egg doing here?

Eggs appear after the PR passes real-behavior proof. It is here for vibes, not verdicts: it does not change labels, ratings, merge decisions, or automation.
The shell reacts to review momentum: open follow-up work warms it up, re-review makes it wobble, and a clean final review lets it hatch.
Hatchability usually comes from sufficient real-behavior proof, no blocking P0/P1/P2 findings, no security attention needed, and clean correctness. A merged PR is already final, so merge makes the egg hatchable independently.
The hatch is seeded from this repository and PR number, so the same PR keeps the same creature; the reviewed head SHA can only change safe visual details.
Rarity is just collectible sparkle: 🥚 common, 🌱 uncommon, 💎 rare, ✨ glimmer, and 🌈 legendary.

* fix: honor OPENCLAW_HOME defaults * fix(install): preserve openclaw home upgrade defaults * fix(install): satisfy shellcheck tilde patterns

@spacegeologist

* fix(doctor): prune stale bundled plugin paths (openclaw#85038) * fix: honor OPENCLAW_HOME defaults (openclaw#85802) * fix: honor OPENCLAW_HOME defaults * fix(install): preserve openclaw home upgrade defaults * fix(install): satisfy shellcheck tilde patterns * fix(config): do not suppress recovery retry after failed backup restore (openclaw#85787) maybeRecoverSuspiciousConfigRead unconditionally recorded lastObservedSuspiciousSignature in health state even when restoredFromBackup was false (copyFile failed). The guard at resolveConfigReadRecoveryContext then prevented the same signature from ever being retried, permanently accepting the suspicious config on every subsequent launch. Only record the dedup signature when the backup restore actually succeeded. * fix(docker): restore config parent ownership * fix(pi-runner): flush blocks after compaction retry (openclaw#85288) (thanks @spacegeologist) Behavior addressed: Embedded PI compaction retry now drains block replies again after the retry wait resolves, so retry-generated replies are not left behind while preserving aggregate-timeout fallback behavior. Real environment tested: local OpenClaw focused Pi runner test shard plus contributor local live-output proof in the PR body. Exact steps or command run after this patch: pnpm test src/agents/pi-embedded-runner/run/attempt.spawn-workspace.context-engine.test.ts src/agents/pi-embedded-runner/run/compaction-retry-aggregate-timeout.test.ts; .agents/skills/autoreview/scripts/autoreview --mode branch --base origin/main Evidence after fix: 2 test files passed, 55 tests passed; final autoreview clean with no accepted/actionable findings. Observed result after fix: the runner flushes before the compaction wait, waits for compaction retry, then performs a second idempotent flush when the wait resolves without timing out. What was not tested: fresh external-channel live retry by this agent; PR retains contributor live-output proof for the delayed channel adapter path. Thanks @spacegeologist. Co-authored-by: zhengzuo0-ai <zheng.zuo0@gmail.com> * feat(gateway): forward OpenAI sampling params (openclaw#84094) Forward OpenAI-compatible frequency_penalty, presence_penalty, and seed params through the gateway/chat-completions path while keeping Responses untouched. Verification: - pnpm test src/gateway/openai-http.test.ts src/agents/pi-embedded-runner/extra-params.sampling.test.ts src/agents/openai-transport-stream.test.ts - CI passed on head 9abb946 after rerunning cancelled jobs: preflight, critical quality network-runtime-boundary, security high, checks, docs, Real behavior proof. Co-authored-by: lellansin <lellansin@gmail.com> * fix: correct build errors from cherry-pick merges - Add missing topP field to AgentStreamParams in shared-types.ts - Replace missing resolveAliasedParamValueFromKeys with existing resolveAliasedParamValue in extra-params.ts - Fix onBlockReplyFlush bare variable reference to params.onBlockReplyFlush in attempt.ts * fix: add missing topP to BaseStreamOptions * fix: add missing openai-http helpers (resolveResponseFormat, resolveErrorMessage, validateOpenAiSamplingParams) * fix(tests): revert context-engine test to origin/main state (ported tests need upstream infrastructure) * fix(tests): restore local import paths broken by upstream cherry-picks * fix(tests): fix remaining cherry-pick compat issues for gemmaclaw - openai-http.ts: add FailoverError import, pass streamParams through buildAgentCommandInput, add integer check for seed param, handle FailoverError format reason as 400 in catch block - openai-http.test.ts: add missing FailoverError import - dockerfile.test.ts: use gemmaclaw stage name base-\${OPENCLAW_VARIANT} instead of upstream base-runtime - test/scripts/install-sh.test.ts: remove test file added by cherry-pick 762ae06; it tests apt_get wrapper, npm freshness, macOS Homebrew, and duplicate-install detection from unported companion commits; file was never on gemmaclaw main --------- Co-authored-by: Gio Della-Libera <giodl73@gmail.com> Co-authored-by: Sebastien Tardif <SebTardif@ncf.ca> Co-authored-by: sallyom <somalley@redhat.com> Co-authored-by: Zee Zheng <zheng.zuo0@gmail.com> Co-authored-by: Lellansin Huang <Lellansin@gmail.com>

* fix: honor OPENCLAW_HOME defaults * fix(install): preserve openclaw home upgrade defaults * fix(install): satisfy shellcheck tilde patterns

openclaw-barnacle Bot added docs Improvements or additions to documentation cli CLI command changes scripts Repository scripts labels May 23, 2026

giodl73-repo assigned steipete May 23, 2026

openclaw-barnacle Bot added size: M maintainer Maintainer-authored PR labels May 23, 2026

giodl73-repo force-pushed the fix-54014-openclaw-home-paths branch 2 times, most recently from b4b30db to 16af92e Compare May 23, 2026 23:43

giodl73-repo force-pushed the fix-54014-openclaw-home-paths branch from f61859d to 4b7fb7b Compare May 24, 2026 02:55

giodl73-repo added 3 commits May 23, 2026 19:57

fix: honor OPENCLAW_HOME defaults

b393a99

fix(install): preserve openclaw home upgrade defaults

59fee90

fix(install): satisfy shellcheck tilde patterns

f974ddd

giodl73-repo force-pushed the fix-54014-openclaw-home-paths branch from 4b7fb7b to f974ddd Compare May 24, 2026 02:59

giodl73-repo merged commit 82af611 into openclaw:main May 24, 2026
103 checks passed

github-actions Bot mentioned this pull request May 24, 2026

📡 Upstream Digest — 2026-05-24 06:54 UTC curtismercier/openclaw-mods#931

Open

frankhli843 mentioned this pull request May 26, 2026

maintenance: upstream openclaw sync 2026-05-26 (selective cherry-picks) gemmaclaw/gemmaclaw#239

Merged

3 tasks

SYU8384 pushed a commit to SYU8384/openclaw that referenced this pull request Jun 3, 2026

fix: honor OPENCLAW_HOME defaults (openclaw#85802)

287dd85

* fix: honor OPENCLAW_HOME defaults * fix(install): preserve openclaw home upgrade defaults * fix(install): satisfy shellcheck tilde patterns

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: honor OPENCLAW_HOME defaults#85802

fix: honor OPENCLAW_HOME defaults#85802
giodl73-repo merged 3 commits into
openclaw:mainfrom
giodl73-repo:fix-54014-openclaw-home-paths

giodl73-repo commented May 23, 2026 •

edited

Loading

Uh oh!

clawsweeper Bot commented May 23, 2026 •

edited

Loading

Uh oh!

clawsweeper Bot commented May 23, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

giodl73-repo commented May 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Verification

Real behavior proof

2026-05-23 update

2026-05-23 ShellCheck update

Uh oh!

clawsweeper Bot commented May 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

clawsweeper Bot commented May 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Hatch command

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

giodl73-repo commented May 23, 2026 •

edited

Loading

clawsweeper Bot commented May 23, 2026 •

edited

Loading

clawsweeper Bot commented May 23, 2026 •

edited

Loading