Problems trying to run matter.js Node Shell as a standalone application

[potto216]

How do you run matter.js Node Shell as a standalone application? I tried following the instructions in https://github.com/project-chip/matter.js/blob/main/packages/nodejs-shell/README.md but got an error message saying the module was not found. Here is what I did.

First I checked my node versions

user@matter-dev:~/matter/tmp_shell$ node --version
v23.2.0
user@matter-dev:~/matter/tmp_shell$ npm --version
10.9.0

Then I installed the shell

user@matter-dev:~/matter/tmp_shell$ npm install @matter/nodejs-shell
(node:398216) ExperimentalWarning: CommonJS module /home/user/.nvm/versions/node/v23.2.0/lib/node_modules/npm/node_modules/debug/src/node.js is loading ES Module /home/user/.nvm/versions/node/v23.2.0/lib/node_modules/npm/node_modules/supports-color/index.js using require().
Support for loading ES Module in require() is an experimental feature and might change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
npm warn deprecated inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
npm warn deprecated @npmcli/move-file@2.0.1: This functionality has been moved to @npmcli/fs
npm warn deprecated npmlog@6.0.2: This package is no longer supported.
npm warn deprecated rimraf@2.7.1: Rimraf versions prior to v4 are no longer supported
npm warn deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm warn deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm warn deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm warn deprecated are-we-there-yet@3.0.1: This package is no longer supported.
npm warn deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm warn deprecated glob@8.1.0: Glob versions prior to v9 are no longer supported
npm warn deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm warn deprecated gauge@4.0.4: This package is no longer supported.

added 192 packages in 2m

36 packages are looking for funding
  run `npm fund` for details

Then I tried to run it but got an error

user@matter-dev:~/matter/tmp_shell$ node shell 1
node:internal/modules/cjs/loader:1246
  throw err;
  ^

Error: Cannot find module '/home/user/matter/tmp_shell/shell'
    at Function._resolveFilename (node:internal/modules/cjs/loader:1243:15)
    at Function._load (node:internal/modules/cjs/loader:1068:27)
    at TracingChannel.traceSync (node:diagnostics_channel:322:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:219:24)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:170:5)
    at node:internal/main/run_main_module:36:49 {
  code: 'MODULE_NOT_FOUND',
  requireStack: []
}

Node.js v23.2.0

The only files in the directory are:

user@matter-dev:~/matter/tmp_shell$ ls
node_modules  package.json  package-lock.json

What should I do to fix this? Thanks!

[Apollon77]

ooh good catch ... infos in https://github.com/project-chip/matter.js/tree/main/packages/nodejs-shell are not right
needs to be "npm run shell 1"

(but "node shell" is wrong in any case :-) )

[Apollon77]

Hm ... seems I need to restest myself. ok What shoukd work in any case is:

cd node_modules/@matter/nodejs-shell and there do npm run shell 1

or

node node_modules/.bin/matter-shell 1

not nice but works ... I needs to checks what npm does there :-(

[potto216]

Yep, both of those run, thanks! Should I create an issue for this?

[Apollon77]

I am trying to find out if there is a better way, else I adjust the docs ... strange

[Apollon77]

Ha, found it ... npx matter-shell 1 in the dir where you installed it

[potto216]

Works for me too. From a clean install using

npm install @matter/nodejs-shell
npx matter-shell 1

worked. I'll close the discussion. Thanks again.