Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (liveblocks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
liveblocks
Liveblocks command line interface.
Commands
liveblocks dev
Start the local Liveblocks dev server (requires Bun):
npx liveblocks devOptions:
| Flag | Description | Default |
|---|---|---|
--port, -p |
Port to listen on. | 1153 |
--host |
Host to bind to. | localhost |
--cmd, -c |
Run a one-off command against a fresh server instance, then shut down. Does not affect your local data in .liveblocks/. |
|
--ci |
Start a fresh server instance on every boot, ideal for CI. | |
--no-check |
Skip project setup check on start. | Checks by default |
--verbose, -v |
Show verbose output. | |
--help, -h |
Show help. |
By default, the dev server scans your project on startup for common Liveblocks
call sites (<LiveblocksProvider>, createClient(), new Liveblocks()) and
warns if any of them are missing a baseUrl pointing at the local dev server.
Use --no-check to skip this check.
liveblocks upgrade
Upgrade all @liveblocks/* packages in your project to the same version:
npx liveblocks upgrade # upgrades to "latest"
npx liveblocks upgrade 2.15.0 # upgrades to a specific versionAutomatically detects your package manager (npm, yarn, pnpm, or bun).
Run with Docker
docker run -p 1153:1153 ghcr.io/liveblocks/dev-serverSee DOCKER.md for configuration and volume mounts.
License
Licensed under the GNU Affero General Public License v3.0 or later, Copyright © 2021-present Liveblocks.
See LICENSE-AGPL-3.0 for more information.