Installing and Setting up Stuart

Stuart is a powerful command line interface (CLI) and core feature of the python package edk2-pytool-extensions. It provides a simple and easy way to build and maintain an Edk2 based UEFI Firmware code tree.

This section goes into how to install stuart, how to build a platform with stuart, and how to perform continuous integration (CI) on a project with stuart.

Note

It is suggested to use python virtual environments to avoid dependency
pollution and conflicts.
[Read More](https://docs.python.org/3/library/venv.html)

Installing on Windows

1. Ensure the latest version of Python3 is installed on your system.

2. Ensure git 2.36.0 or greater is installed

3. Install edk2-pytool-extensions:

   pip install --upgrade edk2-pytool-extensions
   

Installing on Linux

If using WSL, review Getting Started with WSL.

1. Ensure the latest version of Python3 is installed on your system.

   sudo apt install python3, python3-pip, python3-venv
   

2. Ensure git 2.36.0 or greater is installed

3. Install Nuget and dependencies:

   sudo apt-get install mono-complete, nuget, make
   

4. Install edk2-pytool-extensions:

   pip install --upgrade edk2-pytool-extensions
   

Summary

That's it, you are ready to go!

Click Here to learn how to build a platform with Stuart.

Click Here to learn how to perform platform CI with Stuart.