Skip to content

Installation

github-actions edited this page Nov 26, 2025 · 16 revisions

Requirements

Manual 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.

Manual 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)
    • Create the directory C:/Users/{username}/.config/yasb/ and copy styles.css and config.yaml into folder. If you don't have the .config/yasb/ directory, on first run the application will create it for you. To use a custom directory, set the YASB_CONFIG_HOME environment variable.
    • Configure styles.css and config.yaml to your liking.
  • Start the application:
    • run python src/main.py in your terminal (or click yasb.vbs)

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