Guide for the Kimix HTTP serve system — FastAPI backend + TypeScript/Vite frontend. Use when adding new backend endpoints, modifying the session manager, changing the frontend API client, or understanding how data flows from backend to UI. Covers dummy_app.py, dummy_session_manager.py, sse_cli.py, and src/app/.
The English summary is being prepared. Showing the original description.
See how to installReview the instructions the agent will receive before you install.
FastAPI backend (port 4096, REST + SSE) + vanilla TypeScript/Vite frontend (port 5173). dummy_app.py + DummySessionManager for stub prompts; app.py + SessionManager for live SDK sessions.
Start:
uv run kimix gui # dummy backend + Vite dev
uv run kimix gui --build # build frontend first
uv run kimix gui --port 8080 --fe-port 3000
uv run kimix gui --no-fe # backend only
uv run scripts/run_app.py # wrapper → `kimix gui`
uv run kimix ssecli # terminal client for SSE debugging
Backend entry points: dummy_app.py (default), app.py (real), dummy_session_manager.py (stub), session_manager.py (real), serve.py (CLI), client.py (Python async client).
Session manager interface (both managers): create_session, list_sessions, get_session, delete_session, get_messages, prompt_async (204), abort_session, clear_session, compact_session, get_session_status, export_session, get_session_context.
Wire formats: Dummy = {"type": "Text", "text": ..., "time": ...} (Enum.name, no wrapper); Opencode = {"info": {...}, "parts": [{"type": "text"|"tool"|"reasoning"|"step-start"|"step-finish", ...}]}.
Adding a feature: session manager method → HTTP route in dummy_app.py/app.py → KimixClient method → UI wiring in main.ts → optional new MessageType (base.py, types.ts, renderer.ts, styles.css).
Debugging: backend logs to stdout; frontend DevTools Console; API docs at http://127.0.0.1:4096/docs; uv run kimix ssecli for terminal SSE testing.
Full architecture, route patterns, code examples: read references/architecture.md.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Guide for the Kimix web frontend (src/app/) — vanilla TypeScript + Vite, SSE-based chat UI mirroring sse_cli.py. Use when modifying the frontend, adding new UI features, changing the API client, or understanding the message rendering pipeline.
The English summary is being prepared. Showing the original description.
Guide for navigating and maintaining Kimix project documentation. Use when: (1) user asks about the docs structure, (2) user wants to add, update, or append content to project documents.
The English summary is being prepared. Showing the original description.
Guide for using KimiX API utilities covering kimix, kimix.utils, kimix.base, kimix.dag, kimix.network, kimix.server, kimix.parser, kimix.cot, kimix.retrieval, kimix.summarize, and kimi_agent_sdk.
The English summary is being prepared. Showing the original description.
Guide for Kimix opencode-style HTTP server (FastAPI + SSE), including route definitions, builtin endpoints, and app.post usage.
The English summary is being prepared. Showing the original description.
Guide for creating effective skills. Use when users want to create or update a skill that extends agent's capabilities.
The English summary is being prepared. Showing the original description.
Guide for creating tools using CallableTool2 and Params pattern, plus YAML agent registration
The English summary is being prepared. Showing the original description.