UiGuideAgent.Cli
0.11.2
dotnet tool install --global UiGuideAgent.Cli --version 0.11.2
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local UiGuideAgent.Cli --version 0.11.2
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=UiGuideAgent.Cli&version=0.11.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package UiGuideAgent.Cli --version 0.11.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
UiGuide Agent — the uiguide developer tool
This is a .NET tool, not a package for your project. Install it from a command line:
dotnet tool install -g UiGuideAgent.CliFor your application add
UiGuideAgent.Desktop(WPF / WinForms) orUiGuideAgent.Web(Blazor / Razor) instead — their build already runs this tool for you.
You need it only for what a build cannot do for you.
After installing it, open a new terminal and run the commands in your project folder (or give the folder or the .csproj file).
| Command | When to use it |
|---|---|
uiguide init --server https://… |
To connect the project to your company's server. (The server on your own computer is found by the build.) |
uiguide record --goal "…" |
To record a task: it starts your application, and the task you do once becomes a flow in uiguide.map.json. |
uiguide test |
To check the answers: it asks the questions in uiguide.tests.json. |
uiguide doctor |
When something does not work: it checks the whole setup and says what to do. |
uiguide key |
To replace the application key with a new one. |
uiguide update |
To move the project to the latest version. |
uiguide remove |
To remove UiGuide Agent from the project, and if you agree, from this computer. It shows the list and asks first. |
uiguide scan, uiguide bundle |
Only for applications without a .NET or npm build: Python, Java or any exe with the Companion, and web pages without a bundler. |
uiguide help <command>shows a command's options.- Exit codes:
0OK,1problems found,2wrong usage. - Update:
dotnet tool update -g UiGuideAgent.Cli. - Remove:
uiguide removeoffers to remove the tool itself too. - In an npm project the tool comes with
@ui-guide-agent/web: run it asnpx uiguide.
Full guide: https://github.com/DomitorAI/ui-guide-agent/blob/main/docs/cli.md
Free to use without limits, also commercially. Provided as is, without warranty. https://github.com/DomitorAI/ui-guide-agent
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.