openclaw - ✅(Solved) Fix AGENTS.md: outdated gateway launch mechanism docs [1 pull requests, 1 comments, 2 participants]

Official PRs (…)
ON THIS PAGE

Recommended Tools

×6

Utilities matched from this issue’s tags and category — try them while you read without losing context.

GitHub issue graph ai analysis

Paste a GitHub issue URL. We fetch that issue, discover linked issues from bodies/comments/timeline, collect linked pull requests, and produce a structured English report.

The report is written in English Markdown for sharing and archival.

Helpful · Quick feedback

Loading…
GitHub stats
openclaw/openclaw#61615Fetched 2026-04-08 02:56:47
View on GitHub
Comments
1
Participants
2
Timeline
4
Reactions
0
Timeline (top)
commented ×1cross-referenced ×1mentioned ×1subscribed ×1

AGENTS.md line 240 states:

Gateway currently runs only as the menubar app; there is no separate LaunchAgent/helper label installed.

This is outdated. openclaw daemon install supports standalone LaunchAgent registration, and the official onboarding docs recommend openclaw onboard --install-daemon as the primary setup path.

Root Cause

AGENTS.md line 240 states:

Gateway currently runs only as the menubar app; there is no separate LaunchAgent/helper label installed.

This is outdated. openclaw daemon install supports standalone LaunchAgent registration, and the official onboarding docs recommend openclaw onboard --install-daemon as the primary setup path.

Fix Action

Fixed

PR fix notes

PR #61698: Docs/agents gateway daemon launch

Description (problem / solution / changelog)

Summary

  • Problem: AGENTS.md said the gateway runs only with the menubar app and that no separate LaunchAgent is installed, which is wrong now that openclaw daemon install and openclaw onboard --install-daemon register a user LaunchAgent.
  • Why it matters: Readers (including agents using AGENTS.md / CLAUDE.md) may think the Mac app is required, skip the daemon path, and see the gateway stop when the app quits with no service-backed restart.
  • What changed: One bullet under Local Runtime / Platform Notes now describes onboarding’s --install-daemon path, explicit openclaw daemon install, optional Mac app, behavior without a daemon, launchctl inspection, and preferring openclaw daemon lifecycle over ad-hoc tmux when debugging.
  • What did NOT change (scope boundary): No code, config schema, CLI behavior, or Mintlify docs; only repo contributor/agent guidance in AGENTS.md (root CLAUDE.md remains a symlink to it).

Change Type

  • Bug fix
  • Feature
  • Refactor required for the fix
  • Docs
  • Security hardening
  • Chore/infra

Scope

  • Gateway / orchestration
  • Skills / tool execution
  • Auth / tokens
  • Memory / storage
  • Integrations
  • API / contracts
  • UI / DX
  • CI/CD / infra

Linked Issue/PR

  • Closes #61615
  • Related #
  • This PR fixes a bug or regression

Root Cause (if applicable)

  • Root cause: N/A (documentation drift; product gained daemon/LaunchAgent onboarding after the original menubar-only note was written.)
  • Missing detection / guardrail: N/A
  • Contributing context (if known): Original line traced to an older “relay/gateway launch mechanism” doc clarification; not updated when daemon install became the recommended path.

Regression Test Plan (if applicable)

  • Coverage level that should have caught this:
    • Unit test
    • Seam / integration test
    • End-to-end test
    • Existing coverage already sufficient
  • Target test or file: N/A
  • Scenario the test should lock in: N/A
  • Why this is the smallest reliable guardrail: N/A
  • Existing test that already covers this (if any): N/A
  • If no new test is added, why not: Markdown-only guidance change; no runtime behavior to assert.

User-visible / Behavior Changes

None (contributor/agent-facing doc only; end-user product behavior unchanged).

Security Impact (required)

  • New permissions/capabilities? (No)
  • Secrets/tokens handling changed? (No)
  • New/changed network calls? (No)
  • Command/tool execution surface changed? (No)
  • Data access scope changed? (No)

Environment

  • OS: any (doc change)
  • Runtime/container: N/A
  • Model/provider: N/A
  • Integration/channel (if any): N/A
  • Relevant config (redacted): N/A

Steps

  1. Open AGENTS.md and find the “macOS gateway service” bullet under Local Runtime / Platform Notes.
  2. Confirm it mentions:
    • openclaw onboard --install-daemon
    • openclaw daemon install
    • optional Mac app
    • behavior when no daemon is installed

Human Verification (required)

  • Verified scenarios: Read AGENTS.md on the PR branch; confirmed commands are backtick-formatted and aligned with openclaw onboard / openclaw daemon CLI.
  • Edge cases checked: N/A

Review Conversations

  • I replied to or resolved every bot review conversation I addressed in this PR.
  • I left unresolved only the conversations that still need reviewer or maintainer judgment.

Compatibility / Migration

  • Backward compatible? (Yes)
  • Config/env changes? (No)
  • Migration needed? (No)

Changed files

  • AGENTS.md (modified, +1/-1)
RAW_BUFFERClick to expand / collapse

Summary

AGENTS.md line 240 states:

Gateway currently runs only as the menubar app; there is no separate LaunchAgent/helper label installed.

This is outdated. openclaw daemon install supports standalone LaunchAgent registration, and the official onboarding docs recommend openclaw onboard --install-daemon as the primary setup path.

Impact

Users (and AI agents reading AGENTS.md/CLAUDE.md) may believe the macOS app is required to run the gateway, missing the daemon install path entirely. This can lead to the gateway silently going down when the app is quit, with no auto-restart.

History

  • Added in b9cc914729 (2025-12-09) — "Docs: clarify relay launch mechanism"
  • Carried through a3bf2bdd8c (relay→gateway rename)
  • No updates to this line in the 4 months since

Suggested fix

Update the line to reflect that openclaw daemon install is the recommended standalone gateway service path, and the macOS app is an optional companion.

extent analysis

TL;DR

Update the AGENTS.md file to reflect the current recommended setup path using openclaw daemon install for standalone LaunchAgent registration.

Guidance

  • Review the AGENTS.md file and update line 240 to accurately describe the current setup options, including the use of openclaw daemon install for standalone LaunchAgent registration.
  • Verify that the updated documentation aligns with the official onboarding docs, which recommend openclaw onboard --install-daemon as the primary setup path.
  • Consider adding a note to clarify that the macOS app is optional and that the gateway can be run independently using the daemon install path.
  • Test the updated documentation to ensure it accurately reflects the current functionality and setup options.

Example

No code snippet is necessary for this issue, as it relates to updating documentation.

Notes

This fix assumes that the openclaw daemon install command is functional and correctly sets up the LaunchAgent. If there are any issues with this command, additional troubleshooting may be necessary.

Recommendation

Apply workaround: Update the AGENTS.md file to reflect the current recommended setup path, as this will help prevent user confusion and ensure that the documentation accurately reflects the current functionality.

Vote matrix · Quick signals

Works
Did the solution work? Tap to confirm.
Easy Fix
Was it a quick fix?
Time Saver
Did it save you time?
Blocking
Was it severely blocking?
Common Issue
Are others likely hitting this too?
Flaky / Intermittent
Is it intermittent?
Verified / Reproducible
Can you reproduce it reliably?
Loading…

Still need to ship something?

×6

Another batch ranked right after the header list — different links, same matching logic.

Back to top recommendations

TRENDING