Skip to main content

Overview

Print the dashboard URL. The dashboard is served by lerim serve (or lerim up for Docker). No separate server is started by this command.

Syntax

lerim dashboard [--port N]

Parameters

--port
integer
default:"8765"
Bind port for the dashboard server. Uses the port from config if not specified.

Examples

Show default dashboard URL

lerim dashboard
Output:
Dashboard: http://localhost:8765
The dashboard is served by `lerim serve` (or `lerim up` for Docker).

Specify custom port

lerim dashboard --port 9000
Output:
Dashboard: http://localhost:9000
The dashboard is served by `lerim serve` (or `lerim up` for Docker).

Dashboard features

The dashboard provides a local UI for:
  • Overview: High-level metrics and charts (sessions, messages, tools, errors, tokens, activity by day/hour, model usage)
  • Runs: Searchable session list (50/page) with status and metadata; open any run in a full-screen chat viewer
  • Memories: Library + editor for memory records (filter, inspect, edit title/body/kind/confidence/tags)
  • Pipeline: Sync/maintain status, extraction queue state, and latest extraction report
  • Settings: Dashboard-editable config for server, model roles, and tracing; saves to ~/.lerim/config.toml
Top bar filters (Agent, Scope) update dashboard metrics and run listings in real-time.

How to access

  1. Start the Lerim server:
    lerim up          # Docker mode
    # or
    lerim serve       # Direct mode
    
  2. Get the dashboard URL:
    lerim dashboard
    
  3. Open the URL in your browser

Exit codes

  • 0: Success - URL printed

lerim serve

Start the dashboard server

lerim status

Check runtime status

Notes

  • This command only prints the URL; it does not start a server
  • The actual dashboard is served by lerim serve or runs inside the Docker container with lerim up
  • The port defaults to 8765 but can be configured in ~/.lerim/config.toml

Build docs developers (and LLMs) love