Setup your environment with uno-check

uno-check is a dotnet command-line tool that runs a suite of automated check-ups on your dev environment, making sure you have all the prerequisites installed to successfully develop an Uno Platform application. The tool is available on Windows, Linux, and macOS.

If it finds something missing, out of date, or misconfigured, it will either offer to automatically fix it, or else direct you to instructions to manually fix the problem.

uno-check running

Install and run uno-check

  1. Make sure you have the .NET SDK installed.

  2. Open a command-line prompt, Windows Terminal if you have it installed, or else Command Prompt or Windows Powershell from the Start menu.

  3. Setup uno.check by:

    • Installing the tool:

      dotnet tool install -g uno.check
      
    • Updating the tool, if you previously installed it:

      dotnet tool update -g uno.check
      
  4. Run the tool from the command prompt with the following command:

    uno-check
    
  5. Follow the instructions indicated by the tool.

  6. If you get any errors or warnings, run the provided fix or follow the provided instructions. Run uno-check again to verify that the fixes worked.

  7. Once uno-check gives you the green light, you can get started!

Common uno-check command lines

Run uno-check in verbose mode

uno-check -v

This command shows additional logs for each running check.

Run uno-check for a specific platforms

uno-check --target desktop --target web # or ios, android, windows

This command avoids installing tooling that is not needed.

See Command line arguments for more details

Run uno-check in readonly mode on Windows

cmd /c "set __COMPAT_LAYER=RUNASINVOKER && uno-check --ci --non-interactive"

This command only checks for missing tooling and report the results.

Run uno-check in readonly mode on macOS or Linux

uno-check -v --ci --non-interactive

This command only checks for missing tooling and report the results.

Run uno-check to list available checks

uno-check list

This command lists checks that can be skipped using --skip

Run uno-check with specific checks skipped

uno-check --skip androidsdk

This command skips specified checks and runs the rest.