@anchorshell/relay
v0.1.1
Published
Native downloader and launcher for self-hosted AnchorShell Relay Community.
Maintainers
Readme
AnchorShell Relay
Tiny downloader/launcher for the native, source-available Relay Community Go application. Requires Node 22+. No Go compiler required.
Start Relay, then open http://localhost:11730/ in your browser:
npx @anchorshell/relayAdditional commands:
npx @anchorshell/relay
npx @anchorshell/relay install
npx @anchorshell/relay init
npx @anchorshell/relay update
npx @anchorshell/relay --versionNormal execution uses the npm package version: @anchorshell/[email protected] downloads Relay v0.1.0. Binaries are cached in ~/.anchorshell/relay/<version>/<platform-arch>/. install only caches and prints the path. init starts the existing native first-run flow (no dedicated native init command). --version prints the pinned version without downloading.
update caches the latest stable GitHub release when newer than this package. It does not change the package pin: run the printed binary directly, or use the matching newer npm package when published. No automatic updates, PATH changes, services, or sudo.
Ports
npx @anchorshell/relay --port 3030
npx @anchorshell/relay --api-port 11730Both map to native RELAY_HTTP_ADDR. Relay has one shared HTTP listener. Consequently npx @anchorshell/relay --port 3030 --api-port 11730 is rejected with an explanation. Separate UI/API ports require future native support.
Laya (pending)
npx @anchorshell/relay --with-laya
npx @anchorshell/relay --laya-onlyRecognized but exit with a pending-support message. This package does not install Python, Laya, or models. See the Community repository to run Laya separately.
License
Licensed under the AnchorShell Relay Community License 1.0, included in this package as LICENSE. This is a source-available license, not an OSI-approved open-source license.
