Skip to content

Installation

github-actions edited this page Apr 28, 2026 · 17 revisions

Requirements

  • Windows 10 & 11
  • Default YASB theme uses Segoe Fluent Icons font, which is included in Windows 11 by default. Windows 10 users need to download and install the font manually from Microsoft.
  • For custom themes, It's recommended to install Nerd Fonts, which provides a large collection of patched fonts with additional glyphs/icons. You can download and install Nerd Fonts from their official website. Recommended JetBrainsMono Propo

Installation (stable release)

  1. Go to the releases page.
  2. Choice the architecture that matches your system (x64 or ARM64).
  3. Download the yasb-{version}-{architecture}.msi installer.
  4. Run the installer and follow the on-screen instructions.

Installation (latest development build)

  1. Go to the pre release
  2. Choice the architecture that matches your system (x64 or ARM64).
  3. Download the yasb-dev-{architecture}.msi installer.
  4. Run the installer and follow the on-screen instructions.

Using Package Managers (only stable releases)


Winget

Install YASB using winget:

winget install --id AmN.yasb

Scoop

Install YASB using Scoop:

scoop bucket add extras
scoop install extras/yasb

Chocolatey

Install YASB using Chocolatey:

choco install yasb

Using Python

  • Install Python >= 3.14
  • Install the application and its dependencies:
    • pip install . (for regular installation)
    • pip install -e .[dev] (for development installation)
    • pip install -e .[dev,packaging] (for packaging development installation)
  • Start the application:
    • run python src/main.py

Build from source

  • Clone the repository: git clone https://github.com/amnweb/yasb
  • Navigate to the project directory: cd yasb
  • Install the required dependencies: pip install -e .[packaging]
  • Navigate to the src directory: cd src
  • Build the installer using following command:
python build.py build
python build.py bdist_msi

Clone this wiki locally