Uno Check tool
Based on Redth's .NET MAUI Check tool: https://github.com/Redth/dotnet-maui-check
To install the tool:
dotnet tool install -g Uno.Check
To update the tool, if you already have an existing one:
dotnet tool update -g uno.check
To run the tool:
uno-check
If you run into problems with uno-check, you should generally try the following:
- Update the tool to the latest version:
dotnet tool update -g uno.check --source https://api.nuget.org/v3/index.json
- Run with
uno-check --force-dotnet
to ensure the workload repair/update/install commands run regardless of if uno-check thinks the workload versions look good - If you have errors still, it may help to run the Clean-Old-DotNet6-Previews.ps1 script to remove old SDK Packs, templates, or otherwise old cached preview files that might be causing the problem. Try running
uno-check --force-dotnet
again after this step. - Finally, if you have problems, run with
--verbose
flag and capture the output and add it to a new issue.
The following command line arguments can be used to customise the tool's behavior.
Uno Platform supports a number of platforms, and you may only wish to develop for a subset of them. By default the tool runs checks for all supported platforms. If you use the --target
argument, it will only run checks for the nominated target or targets.
So for example the following will only check your environment for web and Linux development:
uno-check --target wasm --target linux
The following argument values for --target
are supported:
Value | Comments |
---|---|
wasm | |
ios | |
android | |
macos | |
skiagtk | |
linux | Alias for skiagtk |
skiawpf | |
skiatizen | |
uwp | |
win32 | |
all | All platforms |
The manifest file is used by the tool to fetch the latest versions and requirements. The default manifest is hosted at: https://raw.githubusercontent.com/unoplatform/uno.check/main/manifests/uno.ui.manifest.json
Use this option to specify an alternative file path or URL to use.
uno-check --manifest /some/other/file
You can try using the --fix
argument to automatically enable solutions to run without being prompted.
uno-check --fix
If you're running on CI you may want to run without any required input with the --non-interactive
argument. You can combine this with --fix
to automatically fix without prompting.
uno-check --non-interactive
This uses a more frequently updated manifest with newer versions of things more often. If you use the prerelease versions of Uno.UI NuGet packages, you should use this flag.
The manifest is hosted by default at: https://raw.githubusercontent.com/unoplatform/uno.check/main/manifests/uno.ui-dev.manifest.json
uno-check --dev
Uses the dotnet-install powershell / bash scripts for installing the dotnet SDK version from the manifest instead of the global installer.
uno-check --ci
Skips a checkup by name or id as listed in uno-check list
.
NOTE: If there are any other checkups which depend on a skipped checkup, they will be skipped too.
uno-check --skip openjdk --skip androidsdk
Lists possible checkups in the format: checkup_id (checkup_name)
.
These can be used to specify --skip checkup_id
, -s checkup_name
arguments.
This allows you to quickly synchronize your global.json
and/or NuGet.config
in the current working directory to utilize the values specified in the manifest.
Arguments:
--dotnet
or--dotnet-version
: Use the SDK version in the manifest inglobal.json
.--dotnet-pre true|false
: Change theallowPrerelease
value in theglobal.json
.--dotnet-rollForward <OPTION>
: Change therollForward
value inglobal.json
to one of the allowed values specified.--nuget
or--nuget-sources
: Adds the nuget sources specified in the manifest to theNuGet.config
and creates the file if needed.
Example:
uno-check config --dev --nuget-sources --dotnet-version --dotnet-pre true