UiGuideAgent.Desktop 0.11.0

UiGuide Agent for WPF and WinForms

🚧 Under active development — not ready for use yet. Parts of what is described here may change or not work yet. Please wait for the first stable release: https://github.com/DomitorAI/ui-guide-agent (Watch → Custom → Releases).

An AI help agent inside your WPF or WinForms application. It answers "how do I…?" with concrete steps — which button to press, what happens next — in the language of the question, starting from the window the user is on. .NET 8+ and .NET Framework 4.8.

Privacy: only the UI structure and labels leave your application — control types, labels, states and the open windows. Never field values, passwords, list / table / tree contents, window titles or screenshots. The filter runs inside your application.

Quick start

1. Add this package (dotnet add package UiGuideAgent.Desktop), build and run: a round button appears in the bottom-right corner of your main window — no code needed. The first build writes uiguide.json (the application id from the project's name) and uiguide.map.json; until the assistant has a server it answers "not configured yet" and the build warns UIG003. Your application works as before either way.
   • .NET Framework 4.8 with the default C# version: add <LangVersion>latest</LangVersion>, or call UiGuide.Attach(this); in your main window's constructor.
2. Connect a server, then rebuild:
   • On your computer: dotnet tool install -g UiGuideAgent.Server.Host, then uiguide-server; set your LLM in the server.json it creates (see the package UiGuideAgent.Server.Host). The next build finds it, writes its address in uiguide.json and registers the application.
   • Your company's: dotnet tool install -g UiGuideAgent.Cli, then in the project folder uiguide init --server https://….
   • The Release build never carries an address of this computer: until your users have one, every build warns UIG003 (<WarningsAsErrors>UIG003</WarningsAsErrors> makes it an error).
3. Ask: click the button and ask "How do I …?". Something wrong? uiguide doctor checks the whole setup and says what to do.

Teach it your application

• Name every control after what it does. Every build warns UIG001 (file and line) for each control without a name — XAML, WinForms designer and controls created in code. Name it in the words a user would use: AutomationProperties.Name="Export orders", WinForms AccessibleName, or its text / label.
• Every build generates uiguide.bundle.json from your windows, controls, UI texts and the code (which control opens which window). In uiguide.map.json describe what the code cannot say: per control action, enabledWhen, opens; and flows.
• UiGuide.SetContext("orderOpen", true) for state the UI doesn't show (state, never user data).
• uiguide record --goal "export the orders" records a flow while you do the task once; uiguide test checks the answers.

uiguide.json options: "language", "position": "bottom-left", "theme", "texts", "autoStart": false (then UiGuide.Attach(window) from your code). API: UiGuide.Attach, Detach, SetLanguage, SetToken, SetContext / RemoveContext / ClearContext, MapScreen, IsAttached.

Updating and removing

• Update: the build tells you when a newer version is out (warning UIG002); update the package as any other.
• Remove: uiguide remove in the project folder takes out the package, uiguide.json, the generated files and the registration on the local server. Uninstalling only the package leaves the uiguide.* files: delete them yourself.

Limits

Windows 10/11; the chat panel needs the Microsoft Edge WebView2 Runtime (the user is offered the download if it is missing). Automatic start needs C# 9; one window at a time (the main window, or a login window shown before it). Building needs the .NET 8+ runtime on the build machine (also for .NET Framework projects).

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

Free to use without limits, including commercially; ship the client libraries unmodified inside your own application (also one you sell). Selling UiGuide Agent itself, or offering it as a paid hosted service, needs the author's permission. Provided as is, without warranty. https://github.com/DomitorAI/ui-guide-agent