CLI Reference
The CLI command is vllm-cluster-manager.
Run --help to see command and flag details:
vllm-cluster-manager --help
vllm-cluster-manager host up --help
vllm-cluster-manager client up --help
Host (host up)
| Flag | Default | Description |
|---|---|---|
--service |
false |
Run as a persistent systemd service. |
--host-ip |
127.0.0.1 |
Bind host for the backend API and UI backend target. |
--host-frontend-port |
5173 |
UI port. |
--host-discover-port |
47528 |
Discovery port used by clients. |
--host-backend-port |
8000 |
Backend API port. |
--postgres-host |
127.0.0.1 |
Postgres host. |
--postgres-port |
5757 |
Postgres port. |
--postgres-db |
vllm_admin |
Postgres database name. |
--postgres-user |
vllm |
Postgres user. |
--postgres-password |
change-me |
Postgres password. |
--base-path |
/ |
Base path for the UI (reverse proxy subpath). |
Client (client up)
| Flag | Default | Description |
|---|---|---|
--service |
false |
Run as a persistent systemd service. |
--host-ip |
127.0.0.1 |
Host IP for discovery. |
--host-discover-port |
47528 |
Host discovery port. |
--client-host |
0.0.0.0 |
Client bind host. |
--client-port |
9000 |
Client bind port. |
--node-name |
<hostname> |
Node name used for registration. |
Examples
Launch host services in the foreground:
vllm-cluster-manager host up --host-ip 127.0.0.1 --host-frontend-port 5173 --host-discover-port 47528
Reverse proxy under /vllm/:
vllm-cluster-manager host up --base-path /vllm/
Launch a client node:
vllm-cluster-manager client up --host-ip 127.0.0.1 --host-discover-port 47528 --node-name node-1
Service mode
Service mode writes systemd unit files and enables them so they start automatically on boot:
vllm-cluster-manager host up --service
vllm-cluster-manager client up --service
Warning
Service mode requires systemd and appropriate permissions. Use sudo when needed.