open-matrix

Repositories

1

Projects Packages

@open-matrix/cli (0.1.23)

Published 2026-07-04 09:41:38 +00:00 by hivecast-admin

Installation

Setup this registry in your project .npmrc file:

@open-matrix:registry=

To install the package using npm, run the following command:

npm install @open-matrix/cli@0.1.23

or add it to the package.json file:

"@open-matrix/cli": "0.1.23"

For more information on the npm registry, see the documentation.

About this package

@open-matrix/cli

Package-author CLI for Matrix SDK.

Scope

This package owns the matrix binary for SDK users who build, package, and run Matrix actors and browser surfaces.

It does not own managed provider login, machine linking, local platform install, or managed host supervision. Provider overlays can add those flows by writing the broker config shape consumed by the SDK runner.

Common Commands

matrix init
matrix actor greeter
matrix package run . --nats-url nats://127.0.0.1:4222 --root demo --check-op echo
matrix actor run ./dist/GreeterActor.js --mount demo.greeter --nats-url nats://127.0.0.1:4222 --root demo --check-op echo
matrix broker setup
matrix broker start --port 4222
matrix broker stop
matrix config set registry https://registry.npmjs.org/
matrix registry doctor

Actor handlers use Matrix handler naming: an accepted op named echo is implemented as onEcho(payload), not echo(payload). matrix actor run validates this before connecting to the broker.

Direct runner credentials are resolved from explicit flags, environment variables, package-local .matrix, and ~/.matrix:

--nats-url / MATRIX_NATS_URL / NATS_URL
--root / --space / MATRIX_ROOT / MATRIX_SPACE
--jwt / MATRIX_NATS_JWT / NATS_JWT
--seed / MATRIX_NATS_SEED / NATS_SEED
./.matrix/credentials/matrix-broker.json
./.matrix/credentials/matrix-nats.json
./.matrix/config.json
~/.matrix/credentials/matrix-broker.json
~/.matrix/credentials/matrix-nats.json
~/.matrix/config.json

JWT and seed must be supplied together. If neither is supplied, the runner connects to the broker without auth, which is intended for local/demo brokers only.

Dependencies

Dependencies

ID	Version
@open-matrix/contracts	0.1.5
@open-matrix/core	0.1.7
@open-matrix/federation	0.2.5
@open-matrix/identity-client	0.1.0
@open-matrix/package-artifacts	0.1.0
@open-matrix/package-runtime	0.1.5
commander	^11.0.0
nats	^2.29.3

Development Dependencies

ID	Version
@types/node	^25.0.10
esbuild	^0.27.3
glob	^13.0.6
tsx	^4.15.6
typescript	^5.7.0

Details

npm

2026-07-04 09:41:38 +00:00

1

MIT

59 KiB

Assets (1)

cli-0.1.23.tgz 59 KiB

Versions (24) View all

0.1.25 2026-07-08

0.1.24 2026-07-07

0.1.23 2026-07-04

0.1.22 2026-07-04

0.1.21 2026-07-04