Skip to content
kazma.
Search Kazma Documentation & Site
ع

Terminal UI (TUI)

Terminal window
kazma-tui

Built with Textual (kazma-tui). Provides a dashboard for chat, status, files/editor, and HITL prompts without a browser.

AreaNotes
ChatTalk to the same agent brain as Web/gateway
Editor / filesIDE-style workspace operations via shared IdeService / tools
DocumentsDocuments tab (DocumentsPanel) — list/inspect processed docs through the running server’s Documents API (upload still Web/chat)
HITLApproval modal widgets for danger tools
StatusModels, gateway, health
LanguageEnglish or Arabic: Ctrl+L, or Ctrl+P → Switch language; the choice is saved. The tabs and the navigation rail follow it in the web UI’s words, with right-to-left styling for Arabic
Demo modeKAZMA_DEMO_MODE (never use in real prod)
  • Nav rail entry Documents (keyboard 8).
  • Reads the running server (kazma serve) through GET /api/documents; with no server it says the platform is unavailable. The server applies the same ACL as on the Web page to the TUI’s credential (the shared secret header, so the operator principal; local when no secret is configured), so it lists the documents that principal can read. Refresh reloads the list.
  • Select a row to preview the first 8,000 characters of its fenced content (GET /api/documents/{document_id}/content); a document that is not ready yet shows “Preview failed”.
  • Upload / convert / GC remain on Web /documents or agent tools — TUI is inspect-first.

Guide: Document Intelligence.

Respects the same kazma.yaml, ConfigStore, and env vars as the Web UI (KAZMA_SECRET when talking to a remote server, vector memory envs, etc.).