@chorus-im/chorus

npm distribution of the Chorus CLI + bridge daemon. Installs the matching prebuilt native binaries from the project's GitHub release; ships no compiled code itself.

Quick start

Run without installing globally:

npx -y @chorus-im/chorus@latest bridge --host chorus.example.com --token chrs_bridge_…

Or install into a project / globally:

npm i -g @chorus-im/chorus
chorus --help
chorus-server --help

What you get

Two binaries, dropped under this package's bin/ directory after postinstall:

• chorus — CLI + bridge daemon (run agents on this machine, talk to a remote platform).
• chorus-server — platform server (HTTP API + embedded UI).

Supported platforms

The release matrix ships:

• Linux x64 (musl)
• Linux arm64 (musl)
• macOS arm64 (Apple Silicon)

Intel macOS and Windows are not in the matrix. On those targets the installer prints a build-from-source hint and exits non-zero.

Versioning

The npm package version always matches a v<version> GitHub release tag. npm i @chorus-im/[email protected] downloads the binaries from v0.14.1.

Publishing

Publishing is automated via .github/workflows/release.yml — when a v* tag is pushed, the workflow builds the native release tarballs, attaches them to the GitHub release, then rewrites npm/package.json's version from the tag and npm publish --access public --provenance. No hand-publish needed for ordinary releases.

One-time setup (operator):

1. Reserve the @chorus-im scope on npmjs.com (publish a first version manually if the scope is new).
2. Create an npm Automation token with publish permissions on the scope.
3. Add it to GitHub repo secrets as NPM_TOKEN.

Manual fallback (e.g. recovering from a workflow failure):

cd npm
npm version 0.14.x --no-git-tag-version       # match a published GH tag
npm publish --access public

License

Apache 2.0 — see LICENSE.