UiGuideAgent.Web 0.10.0

UiGuide Agent for Blazor, Razor Pages / MVC and .NET MAUI Blazor Hybrid

🚧 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 in your .NET web UI. It answers "how do I…?" with concrete steps — which button to press, which page to open — in the language of the question, starting from the page the user is on.

Privacy: the page is read like a screen reader reads it — roles, labels, states. Never field values, passwords, list or table contents.

Quick start

1. Add this package (dotnet add package UiGuideAgent.Web).
2. One line before </body> (wwwroot/index.html, App.razor or _Layout.cshtml):

   <script src="_content/UiGuideAgent.Web/ui-guide-agent.js"></script>
   

3. Build and run. Every build writes uiguide.json (when missing) and wwwroot/uiguide.config.json — what the page reads — generates the knowledge bundle and warns UIG001 for every control without a name. Until the assistant has a server it answers "not configured yet" and the build warns UIG003.
4. Connect a server, then rebuild: on your computer dotnet tool install -g UiGuideAgent.Server.Host, then uiguide-server (see that package); your company's: dotnet tool install -g UiGuideAgent.Cli, then uiguide init --server https://…. The build registers the application with your development addresses (launchSettings.json, https://0.0.0.1 for MAUI Blazor Hybrid); dotnet publish leaves an address of this computer out.

Name controls the browser way: aria-label, <label for> or a <label> around the field, the button's text. Pages get their route from @page "/…"; links and NavigateTo("/…") tell the assistant which page a control opens. Options in uiguide.json: language, position, theme, texts, "autoStart": false. From code (Blazor): await JS.InvokeVoidAsync("uiGuide.setContext", "orderOpen", true);.

Web applications without .NET (React, Vue, Angular, Next.js…) use the npm package @ui-guide-agent/web instead.

Updating and removing

• Update: warning UIG002 tells you; update the package as any other.
• Remove: uiguide remove in the project folder takes out the package, the <script> line, uiguide.json, the generated files and the registration on the local server. Uninstalling only the package leaves the <script> line and the uiguide.* files: delete them yourself.

Full guide: https://github.com/DomitorAI/ui-guide-agent/blob/main/docs/web.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