Skip to content

For the complete documentation index, see llms.txt. Markdown versions of all docs pages are available by appending .md to any docs URL.

Launch the UI

Page as Markdown
Open the kagent dashboard using the CLI or port-forwarding.
Access the kagent dashboard to manage your agents, tools, and models. You can open the dashboard by using the kagent CLI command or by port-forwarding the kagent UI service.
Before you begin

Make sure that kagent is installed in your cluster and the kagent UI service is running.
kubectl get svc -n kagent kagent-ui
Launch the UI with the CLI

The easiest way to launch the kagent dashboard is by using the kagent dashboard command. This command automatically sets up port-forwarding and opens the dashboard in your browser.
Note: The kagent dashboard command is currently available on macOS. On other platforms, use the port-forwarding method described in the next section.
  1. Run the dashboard command:
    kagent dashboard
    The command port-forwards the kagent-ui service to localhost:8082 and opens the dashboard in your default browser.
  2. Access the dashboard at http://localhost:8082.
  3. When you’re done, press Enter in the terminal to stop the port-forward.
Launch the UI with port-forwarding

If you prefer to manually set up port-forwarding, or if you’re on a platform where the kagent CLI isn’t available, you can port-forward the service yourself.
  1. Port-forward the kagent-ui service to your local machine. The following command forwards port 8080 from the service to port 8082 on your local machine.
    kubectl port-forward -n kagent service/kagent-ui 8082:8080
  2. In your browser, open the dashboard at http://localhost:8082.
  3. When you’re done, stop the port-forward by pressing Ctrl+C in the terminal where the port-forward is running.
Expose the UI outside the cluster

Port-forwarding is suitable for local access. For persistent or team-accessible deployments, use one of the following options.
LoadBalancer service

Set ui.service.type: LoadBalancer in your Helm values to provision a cloud load balancer for the UI service.
ui:
  service:
    type: LoadBalancer
After the load balancer is provisioned, get the external IP or hostname from the service.
kubectl get svc -n kagent kagent-ui
OpenShift Route

On OpenShift clusters, kagent automatically creates an edge-terminated Route for the UI when the route.openshift.io/v1 API is present. The route is enabled by default via ui.route.enabled: true.
The default HAProxy timeout is overridden to 120 minutes to prevent long-lived A2A and SSE streams from being terminated. To adjust the timeout:
ui:
  openshiftRoute:
    annotations:
      haproxy.router.openshift.io/timeout: 60m
To disable the auto-created Route and front the UI with your own ingress instead, set ui.route.enabled: false.
Gateway API HTTPRoute

If your cluster uses a Gateway API implementation such as kgateway, Istio, or Envoy Gateway, you can enable an HTTPRoute for the UI with ui.httpRoute.enabled: true.
ui:
  httpRoute:
    enabled: true
    parentRefs:
      - name: my-gateway
        namespace: gateway-system
    hostnames:
      - kagent.example.com
The parentRefs field is required and must reference an existing Gateway. The HTTPRoute resource requires the Gateway API CRDs (gateway.networking.k8s.io/v1) to be installed in your cluster.
Next steps

You can use the UI to view and manage your agents, tools, and models. For more information, see the following guides:
Tracing