using-uno-check.md

uid
UnoCheck.UsingUnoCheck

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.

Install and run uno-check

Windows

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!

Linux

1. Open a Terminal

2. If dotnet --version returns command not found:

   • Follow the official directions for installing .NET.

     [!IMPORTANT] If your distribution is Ubuntu and you want to develop for Android, make sure to use the directions to install the Microsoft feed and not the Ubuntu official feed. The latter does not contain Android workloads.

3. Then, 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

   If the above command fails, use the following:

   ~/.dotnet/tools/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!

macOS

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

2. Open a Terminal.

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

   If the above command fails, use the following:

   ~/.dotnet/tools/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!

---