UiGuideAgent.Companion 0.11.2

UiGuide Agent Companion (uiguide-companion)

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

dotnet tool install -g UiGuideAgent.Companion

For a WPF / WinForms application add UiGuideAgent.Desktop instead, for Blazor / Razor UiGuideAgent.Web.

The help assistant next to any other Windows application, without changing it: Python (PyQt, PySide, Tkinter), Java, Delphi, Electron or any exe.

Quick start

1. A server. Install and start it: dotnet tool install -g UiGuideAgent.Server.Host, then uiguide-server. The package UiGuideAgent.Server.Host explains it step by step.
2. The uiguide tool. Install it once: dotnet tool install -g UiGuideAgent.Cli. Then open a new terminal in the application's folder and run:
   • uiguide init: creates the settings;
   • uiguide scan: lists the controls without a name;
   • uiguide bundle: writes the knowledge bundle.
3. Start the application with the assistant:

   uiguide-companion --config uiguide.json --run "python app.py"
   

   To attach to an application that is already running, use --process python or --window "My App*" instead of --run.

Good to know

• The Companion reads the window through Windows UI Automation: control types, labels and states. Never values.
• It closes when the application it started closes.
• It needs Windows 10 or 11, the .NET 8 Desktop Runtime or newer, and the WebView2 Runtime.
• The application must expose its controls to UI Automation. Qt, the Java Access Bridge, Win32, WPF, WinForms and Chromium do.
• Update: dotnet tool update -g UiGuideAgent.Companion. Remove: dotnet tool uninstall -g UiGuideAgent.Companion.

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

Free to use without limits, also commercially. Provided as is, without warranty. https://github.com/DomitorAI/ui-guide-agent