Liveblocks command line interface.
Start the local Liveblocks dev server (requires Bun):
npx liveblocks devOptions:
| Flag | Description | Default |
|---|---|---|
--port, -p <port> |
Port to listen on. | 1153 |
--random-port, -P |
Bind a random free port. The chosen port is exposed via the LIVEBLOCKS_DEV_SERVER_PORT env var. Ideal for CI. |
|
--host <hostname> |
Host to bind to. | localhost |
--cmd, -c <command> |
Run a command against the server, then shut down. The command inherits LIVEBLOCKS_BASE_URL and the local keys (also NEXT_PUBLIC_, VITE_ and PUBLIC_ prefixed), so apps need no source or .env changes. |
|
--persist |
Keep data in .liveblocks/. |
Without --cmd |
--no-persist |
Use a throwaway directory, leaving .liveblocks/ untouched. |
With --cmd |
--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.
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).
docker run -p 1153:1153 ghcr.io/liveblocks/dev-serverSee DOCKER.md for configuration and volume mounts.
Licensed under the GNU Affero General Public License v3.0 or later, Copyright © 2021-present Liveblocks.
See LICENSE-AGPL-3.0 for more information.