agentleFS
wundercorpwundercorp/loki/web/AGENTS.md

loki / web

AGENTS.md28 starsChanged 2 months agoMITView on GitHub

Applies on top of the root AGENTS.md. Backend routers: loki_cli/web_routers/*.py, one file per dashboard surface, mounted by loki_cli/web_server.py (+ web_server_*.py siblings). Frontend: web/src/. Shared JSON-RPC/WS client: apps/shared (@wundercorp/loki-shared), also used by the desktop. loki_cli/pty_bridge.py + the @app.websocket("/api/pty") endpoint in web_server.py: - web/src/pages/ChatPage.tsx mounts xterm.js Terminal with the WebGL renderer, @xterm/addon-fit (container-driven resize) and @xterm/addon-unicode11 (wide-character widths). - /api/pty?token=… upgrades to a WebSocket; auth uses the same ephemeral _SESSION_TOKEN as REST, passed as a query param because browsers cannot set Authorization…

The file

Files
AGENTS.md

web/ + loki_cli/web_routers/ — the dashboard (loki dashboard → /chat)

Applies on top of the root AGENTS.md. Backend routers: loki_cli/web_routers/*.py, one file per dashboard surface, mounted by loki_cli/web_server.py (+ web_server_*.py siblings). Frontend: web/src/. Shared JSON-RPC/WS client: apps/shared (@wundercorp/loki-shared), also used by the desktop.

The dashboard embeds the REAL loki --tui — not a rewrite

loki_cli/pty_bridge.py + the @app.websocket("/api/pty") endpoint in web_server.py:

  • web/src/pages/ChatPage.tsx mounts xterm.js Terminal with the WebGL renderer, @xterm/addon-fit (container-driven resize) and @xterm/addon-unicode11 (wide-character widths).
  • /api/pty?token=… upgrades to a WebSocket; auth uses the same ephemeral _SESSION_TOKEN as REST, passed as a query param because browsers cannot set Authorization on a WS upgrade.
  • The server spawns exactly what loki --tui would spawn, through ptyprocess (POSIX PTY — WSL works, native Windows does not).
  • Frames are raw PTY bytes each way; resize travels as \x1b[RESIZE:<cols>;<rows>], intercepted on the server and applied with TIOCSWINSZ.

Do not re-implement the primary chat experience in React. Transcript, composer/input flow (including slash-command behaviour), and the PTY-backed terminal belong to the embedded TUI; anything added to Ink shows up here automatically. If you are rebuilding the transcript or composer for the dashboard, stop and extend Ink (tui_gateway/AGENTS.md).

Structured React UI around the TUI is fine when it is not a second chat surface. Sidebar widgets, inspectors, summaries, status panels (ChatSidebar, ModelPickerDialog, ToolCall) complement the embedded TUI. Keep their state independent of the PTY child's session and surface their failures non-destructively so the terminal pane keeps working.

dashboard vs serve

dashboard and serve share cmd_dashboard / start_server but are independent surfaces — neither launches the other. serve is the headless backend the desktop app spawns (headless_backend=True: cmd_dashboard skips _build_web_ui and exports LOKI_SERVE_HEADLESS=1 so mount_spa() disables the SPA even if a stray web_dist/ exists — only JSON-RPC/WS/API is reachable). The desktop has no build/runtime dependency on this frontend. Details: apps/desktop/src/AGENTS.md.

Rules

  • Auth: every new REST route and WS endpoint uses the same session token; never a second scheme.
  • Routers are one-file-per-surface; a new surface is a new web_routers/<surface>.py, not a growing web_server.py.
  • Tests: Python in tests/loki_cli/ (routers, pty bridge); JS in the web/ vitest suite. Python tests must not assert about package.json / .tsx sources (root testing rules). Root TypeScript style rules apply.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.