Skip to main content

kollabor-webui

kollabor-webui is the browser UI shell for kollabor-engine.

It serves the assistant-ui single-page app, proxies engine configuration to the browser, and connects to the local engine API for sessions, assistant-transport streaming, permission prompts, profiles, MCP, and hub controls.

Architecture

Module/Asset Responsibility
src/kollabor_webui/__init__.py kollabor-webui command entrypoint and uvicorn launcher
src/kollabor_webui/server.py FastAPI config endpoint, Vite assets, and SPA fallback
frontend/src/ assistant-ui React/TypeScript source
frontend/dist/ local Vite output (ignored; regenerated for package builds)
src/kollabor_webui/static/ legacy static fallback and packaged assistant-ui output

The checked-in frontend source is the source of truth. hatch_build.py runs npm ci and npm run build when npm is available, then force-includes Vite's frontend/dist output in a wheel under kollabor_webui/static/assistant. The source checkout also serves frontend/dist directly, which makes editable installs useful without copying generated files into git. Python-only builds continue to serve the legacy static/index.html and static/app.js fallback if Node/npm is unavailable.

Interface

  • Sidebar: New Session starts a session with the current picks in one click; the options button next to it opens Agent, Gem, Model and Workspace. Each session row shows its gem as a live 3D avatar that acts out what the agent is doing (thinking, typing, searching, messaging, error).
  • Agents by computer: the sidebar lists every agent under the computer it runs on. This computer comes first: its chats and every agent running in a terminal or as a daemon, each one click from a full chat (the web UI only attaches to an agent it did not start, so it offers no Delete). Then each of your other computers. Agents on other computers show while a chat runs here and this computer is connected to your network. One click opens one as a full chat, through the network, as that computer's trust allows: under open (the default) every computer of your network, under agents only the agents it lets this one message, under manual none.
  • Chat: pill composer with attachments, a /voicemode mic, and a send/stop button; tool calls show while they run and keep their duration. Messages from other agents show as messages from their gems ("Aquamarine → Lapis"), the way the terminal draws its hub boxes; one the agent only overheard is dimmed. Turns the page did not run (a hub message that woke the agent, a turn typed in the terminal) appear without a reload. A failed turn shows its error under your message, also after a reload.
  • Trajectory: every turn, request and tool call as a Table, or as a Waterfall built on @assistant-ui/react-o11y (one block per turn, tools under their model request, each turn on its own time scale).
  • Settings: daemon-owned panels, see docs/features/web-settings-panels.md.
  • Gem Studio (sidebar footer): every agent is born with a random look (eyes and hat) that sticks; dress any gem over it (eyes, hat, color) and set the season for all, previewed live. Random Look rolls a new outfit, Reset goes back to the born look. The engine keeps the looks, so every browser and every gem in the app (session rows, chat, Who Is Online) follows. Each agent has its own look: the studio's list dresses the gems of the folder the web UI runs in, and an agent of the same name in another folder or on another computer is born with its own eyes, hat and color (dress it from its chat's Properties).
  • Session Properties: right-click a session row (long-press on a phone) or double-click its gem to dress that one gem in place. The Chat tab takes the agent off the hub (your other agents stop seeing it; your chat keeps working) or puts it back, with no restart. /hub leave and /hub join do the same in the terminal.

Usage

Quickest path — kollab --web-ui spawns the engine and this package together (reusing an already-running engine on 7433 if one is healthy) and cleans both up on Ctrl+C or SIGTERM:

kollab --web-ui

To run the two pieces separately (useful when iterating on one of them):

Start the engine:

python -m kollabor_engine serve --host 127.0.0.1 --port 7433

Start the web UI:

KOLLAB_ENGINE_URL=http://127.0.0.1:7433 \
KOLLAB_WEBUI_PORT=8080 \
kollabor-webui

Then open:

http://127.0.0.1:8080

To open it from another device, such as a phone on your VPN, list the extra addresses in KOLLAB_WEBUI_HOSTS (comma-separated; it also works with kollab --web-ui). Pages opened there reach the engine through the web UI's /engine proxy, and they get the engine token, so list private addresses only:

KOLLAB_WEBUI_HOSTS=10.8.0.1 kollab --web-ui

For an editable checkout without installed console scripts:

python -c "from kollabor_webui import main; main()"

Frontend development

cd packages/kollabor-webui/frontend
npm ci
npm run typecheck
npm run build
npm run dev

Vite proxies /api, /sessions, /profiles, /mcp, and /hub to the local engine while developing. The production build uses relative asset paths, so FastAPI can serve hashed assets from any mount path and route client-side navigation back to index.html.

The app is not wrapped in <StrictMode>: its dev-only double render breaks @assistant-ui/store 0.3.2 and the composer drops typed text under npm run dev (production is unaffected). Restore it with the assistant-ui 0.15.25 upgrade. src/dev/gem-lab.html previews every gem, activity, hat and season.

Engine endpoints used

  • POST /sessions
  • GET /sessions
  • DELETE /sessions/{session_id}
  • POST /sessions/{session_id}/assistant
  • POST /sessions/{session_id}/cancel (Stop; a closed assistant stream never cancels the turn)
  • POST /sessions/{session_id}/permission
  • GET /sessions/{session_id}/permissions
  • POST /sessions/{session_id}/permissions/mode
  • GET/DELETE /sessions/{session_id}/history (with last_turn_error, why the last turn failed)
  • GET/POST/PUT/DELETE /profiles...
  • GET/POST/PUT/DELETE /mcp/servers...
  • GET/POST /sessions/{session_id}/mcp...
  • GET /agents (gem pool: colors, live state, hub agent ids)
  • GET/PUT /agents/appearance (Gem Studio looks)
  • GET /hub/agents
  • POST /hub/messages

Session rows keep session_id as the API key and expose a separate name for display. Kollab-generated timestamped names display as their slug; opaque UUIDs receive a stable two-word label.

Authentication

The browser gets the current engine bearer token from /api/config, which reads ~/.kollab/engine.token. Every request waits for that first config load, and retries once after a 401 by refreshing it, covering engine restarts that rotate the token.

Validation

python -m py_compile packages/kollabor-webui/src/kollabor_webui/*.py
python -m pytest tests/unit/test_webui_auth_wiring.py -q
cd packages/kollabor-webui/frontend
npm run typecheck
npm run build
node --test tests/*.test.ts

License

MIT

Metadata

Release files for kollabor-webui 0.15.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kollabor-webui 0.15.2
File Size Uploaded
kollabor_webui-0.15.2.tar.gz 832.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kollabor-webui 0.15.2
File Interpreter ABI Platform
kollabor_webui-0.15.2-py3-none-any.whl Python 3 none any Details

Total release size: 1.4 MB

Release files / kollabor_webui-0.15.2.tar.gz

Download URL kollabor_webui-0.15.2.tar.gz
Size 832.4 kB
Tags Source
SHA-256 checksum
How to use checksums
194e88b0f4a2c0aa02bff4384926307e5d49388d8f035b078b07fb29083641ee
BLAKE2b-256 checksum
How to use checksums
fe7c5d69118620c7eccb5d34cdeda2bbcbe65c8c701ecf6dedfc7be1a751e4a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / kollabor_webui-0.15.2-py3-none-any.whl

Download URL kollabor_webui-0.15.2-py3-none-any.whl
Size 610.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
08e349644c9917ab718488b7282e4b89b8ad05037d50bdfdb2391daabd1ff9d9
BLAKE2b-256 checksum
How to use checksums
15939f0b843c6bfbeb95e2b83126a95493ab5c75a3a61723882e2b3bf4583089
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release history Release notifications | RSS feed

1.0.1

2 release files

1.0.0

2 release files

0.15.6

2 release files

0.15.5

2 release files

0.15.4

2 release files

0.15.3

2 release files

This release

0.15.2 This release

2 release files

0.15.1

2 release files

0.15.0

2 release files

0.10.7

2 release files

0.10.6

2 release files

0.10.5

2 release files

0.10.4

2 release files

0.10.3

2 release files

0.10.2

2 release files

0.10.1

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.24

2 release files

0.5.23

2 release files

0.5.22

2 release files

0.5.19

2 release files

0.5.18

2 release files

0.5.16

2 release files

0.5.15

2 release files

0.5.14

2 release files

0.5.13

2 release files

0.5.12

2 release files

0.5.11

2 release files

0.5.8

2 release files

0.5.7

2 release files

0.5.5

2 release files

0.4.22

2 release files

0.4.21

2 release files

0.4.19

2 release 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