Installation¶

Install plotsrv into the Python environment where the code will run.

pipuv

pip install plotsrv

uv add plotsrv

# or add to a dependency group, i.e:
uv add plotsrv --group monitoring

Check the CLI¶

Run:

plotsrv --help

This should print the plotsrv command-line help.

To check the UI:

import plotsrv as ps

ps.publish_view(
    {"status": "ok"},
    label="install check",
    launch_server=True,
)

Open:

http://127.0.0.1:8000

The object should appear in the browser UI.

For SSH-based work, port forwarding is usually the simplest starting point.

Run this on the local machine:

ssh -L 8000:127.0.0.1:8000 user@server

Then run plotsrv on the server and open this locally:

http://127.0.0.1:8000

Avoid exposing plotsrv directly to a public network unless access controls and network boundaries have been considered.

Continue to Quick start.