Skip to content

hivecast package

Status: does not exist. There is no hivecast package subcommand in the wrapper. The wrapper's own help text says so on hivecast.mjs:454:

Package commands live under the matrix binary: matrix install, matrix up, matrix down.

Why two CLIs

hivecast is the product wrapper. It owns Host lifecycle (install, start, stop), cloud pairing (login, connect, link-status), and a small set of operational verbs that delegate to the local Host (status, runtimes, up, down, invoke).

matrix (provided by @matrix/mx-cli) is the package CLI. It owns package authoring, building, testing, publishing, and direct package execution against an arbitrary Host (not just the local one).

The boundary keeps both narrow:

  • A user installing HiveCast for the first time gets one binary (hivecast) and a clean lifecycle.
  • A package author shipping @open-matrix/foo uses matrix for the development loop; they may or may not have a local HiveCast install.
  • hivecast does not need to grow a package-author surface; matrix does not need to grow Host-supervision verbs.

What hivecast does cover for packages

These four subcommands let you supervise a package on the local Host without using matrix directly:

hivecast commandWhat it does
hivecast up <package-or-path>start a package as a supervised runtime on the local Host
hivecast down <runtime-id|package|mount>stop a supervised runtime
hivecast invoke <mount> <op> [json]call into a mounted actor on the local Host
hivecast runtimeslist runtimes currently registered with the local Host

Source: hivecast.mjs:425['init', 'status', 'runtimes', 'up', 'down', 'invoke'] are delegated to the host-service CLI; hivecast.mjs:442-446 documents the up / down / invoke signatures.

What matrix does cover for packages

The matrix binary (built from projects/matrix-3/packages/mx-cli/) covers:

  • Scaffolding and authoring (manifest, runtime entrypoints, app surfaces)
  • Build / test / run-in-place against a folder-backed source
  • Publishing to a Gitea-backed npm-compatible registry
  • Installing from registry / Gitea / local folder
  • Running a package against any Host (matrix run <package-or-path> --home <host-home>)
  • Supervising at a more granular level than hivecast up

For full reference see the separate docs-package-lifecycle package.

If the user types hivecast package

The fall-through in hivecast.mjs:1780-1789 calls failUnsupportedHostCommand, which writes to stderr:

Unsupported Host-mode hivecast command: package
Use matrix for package commands or hivecast --help for Host commands.

…and exits 1.

Target state

A future iteration could add hivecast package as a thin alias that forwards to matrix package for users who only ever want one binary. Not in code today. Lower priority than other launch items.

See also

Source: projects/matrix-3/packages/hivecast/bin/hivecast.mjs line 454 (help text disclaimer) and 425 (delegated command list).