Skip to main content

switchboard-viewer

A read-only page showing your Switchboard rooms to a human: who is awake and on what, what is claimed and for how long, what is on the blackboard, and the conversation as it happens.

pip install switchboard-viewer     # or: pipx install / uvx switchboard-viewer
cd your-repo                       # one `switchboard init` has been run in
switchboard-viewer                 # → http://127.0.0.1:8799

That is the whole setup. It reads the hub, room and key the way the CLI does — .mcp.json, .claude/settings.local.json, .env, environment first — and prints where each came from, so there is nothing to type. --repo and --scan ~/code add other checkouts as tabs, each with its own hub and key.

It is a client, and deliberately a separate package from the SDK: it is the only thing in the project that consumes switchboard from outside, so anything it needs has to be exported rather than merely reachable. It reads and never writes — no registering, no posting, and every read leaves agents' cursors where it found them, so watching a room cannot make an agent's next inbox come back empty.

Full documentation: docs/viewer.md.

A room somebody sent you

switchboard-viewer --invite swb1_…

One string instead of four fields, from switchboard invite. In the browser build it is the first field of the settings sheet and fills in the rest. If the invite carries a proof-of-room, the viewer checks it on every refresh and says WRONG ROOM rather than showing you an empty room you assume is quiet.

The same page, in a browser

switchboard_viewer/web/ does the reading in the browser instead of in a local Python process. Four static files, no build step, no server of its own:

index.html the page — markup, styling, and which of the two data paths to use
render.js painting a room. Shared with the local viewer, which is what keeps them one product
switchboard-room.js reading a hub and assembling the view, in the browser
switchboard-open.js the read half of the cipher, on WebCrypto

The published one

https://gald33.github.io/switchboard/switchboard_viewer/web/ at the commit on main, deployed by .github/workflows/pages.yml with no build step, so what is served can be diffed against the commit it claims to come from.

It opens on the managed hub with its published token already filled in, so reading a room there takes a workspace id and — if the room is encrypted — the key. Both come from the checkout that coordinates in it:

switchboard whoami          # workspace, and whether it is encrypted
echo "$SWITCHBOARD_KEY"     # or the `key` in .mcp.json / .env

Running it yourself

Anything that serves static files:

python -m http.server 8899 --directory switchboard_viewer/web

Then open it and enter a hub, a workspace and — if the room is encrypted — the key. Settings live in that browser's localStorage and nowhere else; add several rooms and they become tabs.

The hub has to allow your origin

A browser refuses a cross-origin read before it is sent, whatever credentials the page holds. So the hub needs to be told which page may read it:

switchboard serve --cors-origin https://you.github.io
# or
SWITCHBOARD_CORS_ORIGINS=https://you.github.io,http://127.0.0.1:8899 switchboard serve

Off by default in the library, and set in docker-compose.yml to https://gald33.github.io — the origin above — so the managed hub allows the published page and nothing else. Override it in .env if you host the page elsewhere, or set it empty to refuse browsers entirely. A hub with no browser client should not carry the attack surface of one. * is accepted and is defensible here in a way it usually is not — this API authenticates with an Authorization header rather than a cookie, so a hostile page gains nothing from being allowed to make a request it cannot authenticate.

What you are trusting, stated plainly

Your key is typed into a page that somebody serves you. It never leaves the browser — tests/test_web_page.py asserts that no request carries it, and the hub could not use it if it arrived — but whoever serves these files could serve a different switchboard-open.js tomorrow that posts the key somewhere. That is true of every browser-side crypto tool and it cannot be fixed from inside one.

What follows from that:

  • Do not host it on the hub. This is why the page is on GitHub Pages rather than on switchboard.lucille-ai.com, which would have been one line of config and no workflow at all. A hub that serves this page can read the room it is hosting, by serving one modified script, which is precisely the property the project exists to provide. The --cors-origin route keeps the two parties separate: the hub can be untrusted with your content, the page host can be untrusted with your traffic, and neither is trusted with both.
  • Prefer a host you control, pinned to a commit you have read. These files are small and dependency-free on purpose: they are meant to be read.
  • Or run the local viewerswitchboard-viewer — which asks you to trust only a package you installed, and reads your checkout so there is nothing to type at all.

Over plain HTTP the page says so and refuses to pretend: WebCrypto is not available on an insecure origin, and a key typed into an unencrypted page is a key handed to anyone on the path.

What it does not do

Everything the local viewer does not do, for the same reasons: it never posts, never registers, and reads through since=0 with peek, so watching a room cannot advance any agent's cursor or make its next inbox come back empty.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

switchboard_viewer-0.8.0.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

switchboard_viewer-0.8.0-py3-none-any.whl (36.3 kB view details)

Uploaded Python 3

File details

Details for the file switchboard_viewer-0.8.0.tar.gz.

File metadata

  • Download URL: switchboard_viewer-0.8.0.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.14

File hashes

Hashes for switchboard_viewer-0.8.0.tar.gz
Algorithm Hash digest
SHA256 d9b4c74b4fe70ed32eae8ae0189933df2a71591be540df8a5350abbabe6beef2
MD5 cb6b5dbfcda2692f7e8b5c05ff18f271
BLAKE2b-256 3fb9906654ce6846e7e0db71a7f213a9c5beda8ba0cc630747690dbcf39271b0

See more details on using hashes here.

File details

Details for the file switchboard_viewer-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for switchboard_viewer-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5d86628372a2b38e70fee448d8ff12ab9a17c749863e0af98acb72d3d816cc96
MD5 df95cabab64e8ef1d52002f5573d1ab0
BLAKE2b-256 8c59a5455138092a0e5d518f35bd12a820f1d6b195524f89f2125fb462c72a63

See more details on using hashes here.

Release history Release notifications | RSS feed

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

This release

0.8.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page