@webmuxapp/cli
v0.1.8
Published
End-user CLI for [Webmux](https://webmux.app) — a web-based terminal multiplexer.
Downloads
111
Readme
@webmuxapp/cli
End-user CLI for Webmux — a web-based terminal multiplexer.
Install
npm i -g @webmuxapp/cliCommands
webmux serve # start (default: :3030 node + :3031 sidecar)
webmux serve --port N # allocate node=N, sidecar=N+1 (auto-pair)
webmux serve --port N --sidecar-port M # override sidecar to M
webmux serve --no-open # don't auto-open the browser
webmux install-service # install as systemd (Linux) / launchd (macOS)
webmux install-service --port N # same, with port pair baked into the unit
webmux uninstall-service # stop + remove the system service only (keeps ~/.webmux/)
webmux update # update CLI + sidecar + SPA to latest
webmux mcp-serve # run the MCP server (stdio, for Claude Code et al.)
webmux version # show installed version
webmux version --check # check for available updates
webmux uninstall # remove the installed service + ~/.webmux/See webmux/SETUP.md for full installation + config reference.
Package layout
This package is assembled from the webmux monorepo by
scripts/prepack.mjs. The tarball bundles:
dist/cli.js— CLI entry point (compiled fromsrc/cli.ts).dist/server/— long-running Node server, copied from<monorepo>/dist/server/.dist/shared/— shared utilities (copied from<monorepo>/dist/shared/).dist/public/— SPA client bundle (Vite output).static/,services/whisper/,config.example.cjs— runtime assets expected at the package root (read viaPROJECT_ROOTinsrc/server/env.ts).node_modules/@webmuxapp/{schemas,ds}/— vendored workspace packages listed inbundleDependencies. Their"prepare"hook emitsdist/*.jsso the tarball is self-contained (no TypeScript loader at runtime).
The CLI auto-detects two deployment layouts at boot (cli.ts):
- git-clone:
packages/cli/dist/cli.jsinside a Webmux checkout. The server is loaded from<monorepo>/dist/server/index.js;git pull+npm install+npm run buildrun at the monorepo root. - npm tarball:
dist/cli.jsinside the installed package. The server is loaded from the same package'sdist/server/index.js.
Release
Push a v<version> tag on main. The release workflow runs npm publish for @webmuxapp/cli.
