UiGuideAgent.Server.Host 0.11.0

UiGuide Agent — the server (uiguide-server)

This is a .NET tool, not a package for your project. Install it from a command line:

dotnet tool install -g UiGuideAgent.Server.Host
uiguide-server

For your application add UiGuideAgent.Desktop (WPF / WinForms) or UiGuideAgent.Web (Blazor / Razor) instead.

🚧 Under active development — not ready for use yet. https://github.com/DomitorAI/ui-guide-agent

The server runs the agent: it keeps your applications' knowledge bundles and conversations and calls your OpenAI-compatible LLM (LiteLLM, vLLM, Ollama, OpenAI…). Your LLM, your key — UiGuide Agent does not include or pay for a model. Requires the .NET SDK 10.

On your computer (to develop and try)

1. dotnet tool install -g UiGuideAgent.Server.Host, then uiguide-server.
2. Its first start creates your settings, %LOCALAPPDATA%\ui-guide-agent\server.json (Linux / macOS: ~/.local/share/ui-guide-agent/server.json; kept when the server is updated): set your LLM there — "Llm" → "BaseUrl", "Model", and, recommended, "EmbeddingModel" (an embedding model on the same endpoint, e.g. bge-m3: questions asked in other words are answered from the cache too, with fewer LLM calls); the key only as the environment variable Llm__ApiKey. Start it again and check http://localhost:5180/api/v1/health → "llm": "ok" (and "embeddings": "ok").
3. Rebuild your application: the build finds the server, writes its address and registers the application.

On its own computer the server needs no authentication. Update: dotnet tool update -g UiGuideAgent.Server.Host (settings and data kept); remove: uiguide remove (it stops the server and removes it with its settings and data), or dotnet tool uninstall -g UiGuideAgent.Server.Host and delete %LOCALAPPDATA%\ui-guide-agent.

For your company

One server for all your applications and users: the Docker image (docker pull ghcr.io/domitorai/ui-guide-agent-server) or, on a Windows server, this tool as a Windows service — in an administrator terminal uiguide-server service install, set the LLM in C:\ProgramData\ui-guide-agent\server.json, uiguide-server service key, uiguide-server service start (it starts with Windows; after a crash restarted up to 3 times a day; uiguide-server service status). The developer runs uiguide init --server https://… and sends the administrator the one line it prints (application key, limits, web pages allowed); authentication by application key or by your own sign-in, limits per application and per user, Prometheus metrics, answer cache, learned navigation.

Full guide: https://github.com/DomitorAI/ui-guide-agent/blob/main/docs/company-server.md

Free to use without limits, including commercially. Offering UiGuide Agent as a paid hosted service needs the author's permission. Provided as is, without warranty. https://github.com/DomitorAI/ui-guide-agent