kcp ui
kcp ui¶
Start the UI
Synopsis¶
Starts the kcp UI — a local web app for visualising and analysing kcp-state.json (clusters, costs, metrics, TCO) and for generating migration assets via a guided wizard.
Runs entirely locally on http://localhost:<port> (default 5556); no data leaves your machine.
By default the server binds to localhost and is reachable only from this machine. To reach it from another host or from inside a container, bind a wider interface with --host 0.0.0.0. The UI has no authentication, so only do this intentionally and restrict exposure — for example publish the container port on loopback only: docker run -p 127.0.0.1:5556:5556 ... kcp ui --host 0.0.0.0.
Examples¶
# Default port (5556), localhost only
kcp ui
# Custom port
kcp ui --port 8080
# Bind all interfaces so the UI is reachable from outside (e.g. a container).
# No auth — restrict exposure (e.g. Docker: -p 127.0.0.1:5556:5556).
kcp ui --host 0.0.0.0
# Pre-load a state file on launch
kcp ui --state-file kcp-state.json
Options¶
-h, --help help for ui
--host string Host/interface to bind the UI server to. Use 0.0.0.0 to allow access from other machines or from inside a container; the UI has no authentication, so restrict exposure (e.g. Docker: -p 127.0.0.1:<port>:<port>) (default "localhost")
--port string Port to run the UI server on (default "5556")
--state-file string Path to a KCP state file to pre-load
Options inherited from parent commands¶
SEE ALSO¶
- kcp - A CLI tool for kafka cluster planning and migration