komorebi/docs/getting-started.md

hide

hide
navigation

Installation

Komorebi is available pre-built to install via Scoop and WinGet, and you may also built it from source if you would prefer.

• Scoop
• WinGet
• Build from source

Getting Example Configurations

Run the following command to download example configuration files for komorebi and whkd. Pay attention to the output of the command to see where the example files have been downloaded.

komorebic quickstart

Starting Komorebi

Run the following command to start komorebi and whkd with the example configurations.

It is important that you run this command for the first time without making any modifications to the example configurations to validate that you have a working installation of both komorebi and whkd.

komorebic start --whkd