UiGuideAgent.Web 0.11.2

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

An AI help agent in your .NET web UI. Your users ask "how do I…?" and get concrete steps: which button to press and which page to open. The answer is in the language of the question and starts from the page the user is on.

Privacy: the page is read the way a screen reader reads it: roles, labels and states. Never field values, passwords, or the contents of lists and tables.

Safe answers: the assistant never gives links, downloads or commands, never asks for passwords, codes or card details, and ignores instructions hidden in texts shown by your application.

Quick start

1. Add this package:

   dotnet add package UiGuideAgent.Web
   

2. Add this line to your page, before </body>:

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

   The page is wwwroot/index.html, App.razor or _Layout.cshtml.

3. Build and run. Every build writes your settings (uiguide.json, the first time) and what the page reads (wwwroot/uiguide.config.json). It also generates the knowledge bundle, and shows the warning UIG001 for every control without a name. Until the assistant has a server, it answers "not configured yet" and the build shows the warning UIG003.

4. Connect a server, then rebuild:

   • On your computer: dotnet tool install -g UiGuideAgent.Server.Host, then uiguide-server. The package UiGuideAgent.Server.Host explains it step by step.
   • Your company's server: dotnet tool install -g UiGuideAgent.Cli, then uiguide init --server https://… in your project folder.

   The build registers your application with your development addresses. dotnet publish leaves the address of your computer out.

Good to know

• Name controls the browser way: aria-label, a <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.
• Settings in uiguide.json: language (fixes the language), position, theme, texts, "autoStart": false.
• The language: the assistant follows the language your page shows. The answer is in the language of the question.
• 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: the warning UIG002 tells you. Update the package like any other.
• Remove: run uiguide remove in the project folder. It removes the package, the <script> line, uiguide.json, the generated files, their copies in bin and obj, and the registration on the server on your computer. If you only uninstall the package, the <script> line and the uiguide.* files stay: delete them yourself.

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

Free to use without limits, also commercially. You may 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