docs: clarify Node.js and pnpm requirements for Matrix plugin#5302
docs: clarify Node.js and pnpm requirements for Matrix plugin#5302Deep-27 wants to merge 3 commits intoopenclaw:mainfrom
Conversation
Greptile OverviewGreptile SummaryThis PR adds documentation clarifying the environment requirements for OpenClaw and the Matrix plugin. It addresses issue #5292 by documenting that Node.js >= 22.12.0 and pnpm are required, which matches the Key changes:
Potential improvements:
The documentation accurately reflects the technical requirements and will help users avoid the plugin loading errors mentioned in the issue. Confidence Score: 4/5
|
| Filename | Overview |
|---|---|
| README.md | Added environment requirements section clarifying Node.js >= 22.12.0 and pnpm requirements for Matrix plugin |
Sequence Diagram
sequenceDiagram
participant User
participant OpenClaw
participant MatrixPlugin
participant NodeRuntime
participant pnpm
User->>OpenClaw: Install OpenClaw
User->>OpenClaw: Install Matrix plugin
OpenClaw->>pnpm: Check pnpm availability
alt pnpm not available
pnpm-->>OpenClaw: Error: pnpm not found
OpenClaw-->>User: Unclear error (plugin fails to load)
else pnpm available
OpenClaw->>NodeRuntime: Check Node.js version
alt Node.js < 22.12.0
NodeRuntime-->>OpenClaw: Unsupported version
OpenClaw-->>User: Unclear error (plugin fails to load)
else Node.js >= 22.12.0
OpenClaw->>MatrixPlugin: Load plugin with dependencies
MatrixPlugin->>pnpm: Install workspace dependencies
pnpm-->>MatrixPlugin: Dependencies installed
MatrixPlugin-->>OpenClaw: Plugin loaded successfully
OpenClaw-->>User: Matrix plugin ready
end
end
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
|
The failing CI check appears to be unrelated to this PR. This PR only changes documentation (README.md). The failure is in No Docker or test-related files were modified in this PR. |
|
This does not fix #5292 and may not be needed, are you sure anything in OpenClaw actually requires Node 22.12? |
Summary
Clarifies the environment requirements for running the Matrix plugin.
Context
The Matrix extension already declares its dependencies, but running OpenClaw
with unsupported Node.js versions or without pnpm causes the plugin to fail
to load with unclear errors.
Changes
Fixes #5292