Skip to content

docs: clarify Node.js and pnpm requirements for Matrix plugin#5302

Closed
Deep-27 wants to merge 3 commits intoopenclaw:mainfrom
Deep-27:fix/matrix-plugin
Closed

docs: clarify Node.js and pnpm requirements for Matrix plugin#5302
Deep-27 wants to merge 3 commits intoopenclaw:mainfrom
Deep-27:fix/matrix-plugin

Conversation

@Deep-27
Copy link
Copy Markdown

@Deep-27 Deep-27 commented Jan 31, 2026

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

  • Documented required Node.js version (>= 22.12.0)
  • Clarified pnpm workspace requirement

Fixes #5292

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Jan 31, 2026

Greptile Overview

Greptile Summary

This 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 engines field in package.json:153.

Key changes:

  • Added new "Environment Requirements" section explaining Node.js >= 22.12.0 and pnpm requirements
  • Clarified that running with unsupported versions causes Matrix plugin to fail with unclear errors
  • Added two blank lines before "Runtime: Node ≥22." in the install section

Potential improvements:

  • The new section placement (after quick start examples) creates an awkward flow - consider moving it earlier
  • "workspace install required" phrasing is ambiguous about when pnpm is actually needed
  • Trailing whitespace at line 83
  • Two unnecessary blank lines added at lines 44-45

The documentation accurately reflects the technical requirements and will help users avoid the plugin loading errors mentioned in the issue.

Confidence Score: 4/5

  • Safe to merge with minor documentation style improvements recommended
  • The PR correctly documents the Node.js version requirement matching package.json engines field and addresses a real user pain point. The content is accurate and helpful, though the section placement and some phrasing could be improved. No functional code changes, only documentation additions.
  • No files require special attention - all changes are documentation improvements to README.md

Important Files Changed

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
Loading

Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 4 comments

Edit Code Review Agent Settings | Greptile

Deep-27 and others added 2 commits January 31, 2026 15:06
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@Deep-27
Copy link
Copy Markdown
Author

Deep-27 commented Jan 31, 2026

The failing CI check appears to be unrelated to this PR.

This PR only changes documentation (README.md). The failure is in
src/docker-setup.test.ts, where the test expects a literal "gateway"
string, but the generated docker-compose output uses structured YAML
(openclaw-gateway with command: ['node', 'dist/index.js', 'gateway', ...]).

No Docker or test-related files were modified in this PR.
Happy to re-run checks or let maintainers decide how to proceed.

@joshuafhiggins
Copy link
Copy Markdown

This does not fix #5292 and may not be needed, are you sure anything in OpenClaw actually requires Node 22.12?

@sebslight sebslight closed this Feb 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Matrix plugin non-functional

3 participants