From 8ca13170f779f431ec528addd80467ac60706782 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Fri, 10 May 2024 14:39:51 -0700 Subject: [PATCH] Deployed 1accbf6 with MkDocs version: 1.5.2 --- 404.html | 22 + cli/active-window-border-colour.html | 27 +- cli/active-window-border-offset.html | 27 +- cli/active-window-border-width.html | 27 +- cli/active-window-border.html | 27 +- cli/adjust-container-padding.html | 27 +- cli/adjust-workspace-padding.html | 27 +- cli/ahk-app-specific-configuration.html | 27 +- cli/ahk-library.html | 27 +- ...ication-specific-configuration-schema.html | 27 +- cli/change-layout.html | 27 +- cli/check.html | 27 +- cli/clear-named-workspace-layout-rules.html | 27 +- cli/clear-workspace-layout-rules.html | 27 +- cli/close.html | 27 +- cli/complete-configuration.html | 27 +- cli/configuration.html | 27 +- cli/container-padding.html | 27 +- cli/cross-monitor-move-behaviour.html | 29 +- cli/cycle-focus.html | 27 +- cli/cycle-layout.html | 27 +- cli/cycle-monitor.html | 27 +- cli/cycle-move-to-monitor.html | 27 +- cli/cycle-move-to-workspace.html | 27 +- cli/cycle-move.html | 27 +- cli/cycle-send-to-monitor.html | 27 +- cli/cycle-send-to-workspace.html | 27 +- cli/cycle-stack.html | 27 +- cli/cycle-workspace.html | 27 +- cli/disable-autostart.html | 27 +- cli/display-index-preference.html | 27 +- cli/enable-autostart.html | 29 +- cli/ensure-named-workspaces.html | 27 +- cli/ensure-workspaces.html | 27 +- cli/fetch-app-specific-configuration.html | 27 +- cli/flip-layout.html | 27 +- cli/float-rule.html | 27 +- cli/focus-follows-mouse.html | 29 +- cli/focus-last-workspace.html | 27 +- cli/focus-monitor-workspace.html | 27 +- cli/focus-monitor.html | 27 +- cli/focus-named-workspace.html | 27 +- cli/focus-workspace.html | 27 +- cli/focus-workspaces.html | 27 +- cli/focus.html | 27 +- cli/focused-workspace-container-padding.html | 27 +- cli/focused-workspace-padding.html | 27 +- cli/force-focus.html | 27 +- cli/format-app-specific-configuration.html | 27 +- cli/generate-static-config.html | 27 +- cli/global-state.html | 27 +- cli/global-work-area-offset.html | 27 +- cli/identify-layered-application.html | 27 +- ...entify-object-name-change-application.html | 27 +- cli/identify-tray-application.html | 27 +- cli/initial-named-workspace-rule.html | 27 +- cli/initial-workspace-rule.html | 27 +- cli/invisible-borders.html | 27 +- cli/load-custom-layout.html | 27 +- cli/load-resize.html | 27 +- cli/log.html | 27 +- cli/manage-rule.html | 27 +- cli/manage.html | 27 +- cli/minimize.html | 27 +- cli/monitor-index-preference.html | 35 +- cli/monitor-work-area-offset.html | 27 +- cli/mouse-follows-focus.html | 27 +- cli/move-to-monitor-workspace.html | 27 +- cli/move-to-monitor.html | 27 +- cli/move-to-named-workspace.html | 27 +- cli/move-to-workspace.html | 27 +- cli/move-workspace-to-monitor.html | 27 +- cli/move.html | 27 +- cli/named-workspace-container-padding.html | 27 +- cli/named-workspace-custom-layout-rule.html | 27 +- cli/named-workspace-custom-layout.html | 27 +- cli/named-workspace-layout-rule.html | 27 +- cli/named-workspace-layout.html | 27 +- cli/named-workspace-padding.html | 27 +- cli/named-workspace-rule.html | 27 +- cli/named-workspace-tiling.html | 27 +- cli/new-workspace.html | 27 +- cli/notification-schema.html | 27 +- cli/promote-focus.html | 27 +- cli/promote.html | 27 +- cli/pwsh-app-specific-configuration.html | 27 +- cli/query.html | 27 +- cli/quick-load-resize.html | 27 +- cli/quick-save-resize.html | 27 +- cli/quickstart.html | 27 +- cli/reload-configuration.html | 27 +- cli/remove-title-bar.html | 27 +- cli/resize-axis.html | 27 +- cli/resize-delta.html | 27 +- cli/resize-edge.html | 27 +- cli/restore-windows.html | 27 +- cli/retile.html | 27 +- cli/save-resize.html | 27 +- cli/send-to-monitor-workspace.html | 27 +- cli/send-to-monitor.html | 27 +- cli/send-to-named-workspace.html | 27 +- cli/send-to-workspace.html | 27 +- cli/socket-schema.html | 27 +- cli/stack.html | 27 +- cli/start.html | 31 +- cli/state.html | 27 +- cli/static-config-schema.html | 27 +- cli/stop.html | 27 +- cli/subscribe-pipe.html | 27 +- cli/subscribe-socket.html | 27 +- cli/swap-workspaces-with-monitor.html | 27 +- cli/toggle-cross-monitor-move-behaviour.html | 27 +- cli/toggle-float.html | 27 +- cli/toggle-focus-follows-mouse.html | 29 +- cli/toggle-maximize.html | 27 +- cli/toggle-monocle.html | 27 +- cli/toggle-mouse-follows-focus.html | 27 +- cli/toggle-pause.html | 27 +- cli/toggle-tiling.html | 27 +- cli/toggle-title-bars.html | 27 +- cli/toggle-window-container-behaviour.html | 27 +- cli/unmanage.html | 27 +- cli/unmanaged-window-operation-behaviour.html | 29 +- cli/unstack.html | 27 +- cli/unsubscribe-pipe.html | 27 +- cli/unsubscribe-socket.html | 27 +- cli/visible-windows.html | 27 +- cli/watch-configuration.html | 27 +- cli/whkdrc.html | 27 +- cli/window-hiding-behaviour.html | 29 +- cli/workspace-custom-layout-rule.html | 27 +- cli/workspace-custom-layout.html | 27 +- cli/workspace-layout-rule.html | 27 +- cli/workspace-layout.html | 27 +- cli/workspace-name.html | 27 +- cli/workspace-padding.html | 27 +- cli/workspace-rule.html | 27 +- cli/workspace-tiling.html | 27 +- common-workflows/active-window-border.html | 67 +- common-workflows/autohotkey.html | 32 +- common-workflows/custom-layouts.html | 62 +- .../dynamic-layout-switching.html | 64 +- common-workflows/focus-follows-mouse.html | 34 +- common-workflows/force-manage-windows.html | 42 +- common-workflows/ignore-windows.html | 42 +- common-workflows/komorebi-config-home.html | 46 +- common-workflows/mouse-follows-focus.html | 30 +- common-workflows/remove-gaps.html | 36 +- common-workflows/stackbar.html | 48 +- .../tray-and-multi-window-applications.html | 42 +- design.html | 26 +- example-configurations.html | 198 +- index.html | 22 + installation.html | 48 +- release/v0-1-22.html | 60 +- search/search_index.json | 2 +- troubleshooting.html | 4351 +++++++++++++++++ 157 files changed, 8310 insertions(+), 687 deletions(-) create mode 100644 troubleshooting.html diff --git a/404.html b/404.html index 838b33c9..12337e1c 100644 --- a/404.html +++ b/404.html @@ -461,6 +461,8 @@ + +
  • @@ -529,6 +531,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + diff --git a/cli/active-window-border-colour.html b/cli/active-window-border-colour.html index 4d07866c..ba5cc285 100644 --- a/cli/active-window-border-colour.html +++ b/cli/active-window-border-colour.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    active-window-border-colour

    -
    Set the colour for the active window border
+
    Set the colour for the active window border
 
 Usage: komorebic.exe active-window-border-colour [OPTIONS] <R> <G> <B>
 
@@ -4056,8 +4078,7 @@ Options:
 
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/active-window-border-offset.html b/cli/active-window-border-offset.html index 5be7a193..a457329a 100644 --- a/cli/active-window-border-offset.html +++ b/cli/active-window-border-offset.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    active-window-border-offset

    -
    Set the offset for the active window border
+
    Set the offset for the active window border
 
 Usage: komorebic.exe active-window-border-offset <OFFSET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/active-window-border-width.html b/cli/active-window-border-width.html index 0a84dc9a..9ac803a0 100644 --- a/cli/active-window-border-width.html +++ b/cli/active-window-border-width.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    active-window-border-width

    -
    Set the width for the active window border
+
    Set the width for the active window border
 
 Usage: komorebic.exe active-window-border-width <WIDTH>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/active-window-border.html b/cli/active-window-border.html index 5988e0af..91e8bf12 100644 --- a/cli/active-window-border.html +++ b/cli/active-window-border.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    active-window-border

    -
    Enable or disable the active window border
+
    Enable or disable the active window border
 
 Usage: komorebic.exe active-window-border <BOOLEAN_STATE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/adjust-container-padding.html b/cli/adjust-container-padding.html index 2c0fac64..233fc5bc 100644 --- a/cli/adjust-container-padding.html +++ b/cli/adjust-container-padding.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    adjust-container-padding

    -
    Adjust container padding on the focused workspace
+
    Adjust container padding on the focused workspace
 
 Usage: komorebic.exe adjust-container-padding <SIZING> <ADJUSTMENT>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/adjust-workspace-padding.html b/cli/adjust-workspace-padding.html index 260fde5e..1c28445e 100644 --- a/cli/adjust-workspace-padding.html +++ b/cli/adjust-workspace-padding.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    adjust-workspace-padding

    -
    Adjust workspace padding on the focused workspace
+
    Adjust workspace padding on the focused workspace
 
 Usage: komorebic.exe adjust-workspace-padding <SIZING> <ADJUSTMENT>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/ahk-app-specific-configuration.html b/cli/ahk-app-specific-configuration.html index d808acaa..0778ed3d 100644 --- a/cli/ahk-app-specific-configuration.html +++ b/cli/ahk-app-specific-configuration.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    ahk-app-specific-configuration

    -
    Generate common app-specific configurations and fixes to use in komorebi.ahk
+
    Generate common app-specific configurations and fixes to use in komorebi.ahk
 
 Usage: komorebic.exe ahk-app-specific-configuration <PATH> [OVERRIDE_PATH]
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/ahk-library.html b/cli/ahk-library.html index 9b735241..1c6490b1 100644 --- a/cli/ahk-library.html +++ b/cli/ahk-library.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    ahk-library

    -
    Generate a library of AutoHotKey helper functions
+
    Generate a library of AutoHotKey helper functions
 
 Usage: komorebic.exe ahk-library
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/application-specific-configuration-schema.html b/cli/application-specific-configuration-schema.html index 88089edb..883364f7 100644 --- a/cli/application-specific-configuration-schema.html +++ b/cli/application-specific-configuration-schema.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    application-specific-configuration-schema

    -
    Generate a JSON Schema for applications.yaml
+
    Generate a JSON Schema for applications.yaml
 
 Usage: komorebic.exe application-specific-configuration-schema
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/change-layout.html b/cli/change-layout.html index b87afa3b..14bf1a92 100644 --- a/cli/change-layout.html +++ b/cli/change-layout.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    change-layout

    -
    Set the layout on the focused workspace
+
    Set the layout on the focused workspace
 
 Usage: komorebic.exe change-layout <DEFAULT_LAYOUT>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/check.html b/cli/check.html index 4cfaa8f1..32461fcf 100644 --- a/cli/check.html +++ b/cli/check.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    check

    -
    Check komorebi configuration and related files for common errors
+
    Check komorebi configuration and related files for common errors
 
 Usage: komorebic.exe check
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/clear-named-workspace-layout-rules.html b/cli/clear-named-workspace-layout-rules.html index a063e5ab..a27fb3ed 100644 --- a/cli/clear-named-workspace-layout-rules.html +++ b/cli/clear-named-workspace-layout-rules.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    clear-named-workspace-layout-rules

    -
    Clear all dynamic layout rules for the specified workspace
+
    Clear all dynamic layout rules for the specified workspace
 
 Usage: komorebic.exe clear-named-workspace-layout-rules <WORKSPACE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/clear-workspace-layout-rules.html b/cli/clear-workspace-layout-rules.html index 3758a0ca..be7fe5c4 100644 --- a/cli/clear-workspace-layout-rules.html +++ b/cli/clear-workspace-layout-rules.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    clear-workspace-layout-rules

    -
    Clear all dynamic layout rules for the specified workspace
+
    Clear all dynamic layout rules for the specified workspace
 
 Usage: komorebic.exe clear-workspace-layout-rules <MONITOR> <WORKSPACE>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/close.html b/cli/close.html index 0af1b9f3..e1a521ec 100644 --- a/cli/close.html +++ b/cli/close.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    close

    -
    Close the focused window
+
    Close the focused window
 
 Usage: komorebic.exe close
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/complete-configuration.html b/cli/complete-configuration.html index 4033ef3d..37fdaeaa 100644 --- a/cli/complete-configuration.html +++ b/cli/complete-configuration.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    complete-configuration

    -
    Signal that the final configuration option has been sent
+
    Signal that the final configuration option has been sent
 
 Usage: komorebic.exe complete-configuration
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/configuration.html b/cli/configuration.html index 9e8220f5..2d68f392 100644 --- a/cli/configuration.html +++ b/cli/configuration.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    configuration

    -
    Show the path to komorebi.json
+
    Show the path to komorebi.json
 
 Usage: komorebic.exe configuration
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/container-padding.html b/cli/container-padding.html index dc547b96..e1dc21e8 100644 --- a/cli/container-padding.html +++ b/cli/container-padding.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    container-padding

    -
    Set the container padding for the specified workspace
+
    Set the container padding for the specified workspace
 
 Usage: komorebic.exe container-padding <MONITOR> <WORKSPACE> <SIZE>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cross-monitor-move-behaviour.html b/cli/cross-monitor-move-behaviour.html index 03987426..c9bd90d4 100644 --- a/cli/cross-monitor-move-behaviour.html +++ b/cli/cross-monitor-move-behaviour.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cross-monitor-move-behaviour

    -
    Set the behaviour when moving windows across monitor boundaries
+
    Set the behaviour when moving windows across monitor boundaries
 
 Usage: komorebic.exe cross-monitor-move-behaviour <MOVE_BEHAVIOUR>
 
@@ -4047,9 +4069,8 @@ Arguments:
 
 Options:
   -h, --help
-          Print help (see a summary with '-h')
-
-
    
+          Print help (see a summary with '-h')
+
    diff --git a/cli/cycle-focus.html b/cli/cycle-focus.html index ff66c2ae..bbe9be4f 100644 --- a/cli/cycle-focus.html +++ b/cli/cycle-focus.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-focus

    -
    Change focus to the window in the specified cycle direction
+
    Change focus to the window in the specified cycle direction
 
 Usage: komorebic.exe cycle-focus <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cycle-layout.html b/cli/cycle-layout.html index 79520f73..613a1b36 100644 --- a/cli/cycle-layout.html +++ b/cli/cycle-layout.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-layout

    -
    Cycle between available layouts
+
    Cycle between available layouts
 
 Usage: komorebic.exe cycle-layout <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cycle-monitor.html b/cli/cycle-monitor.html index 11852667..13b6889a 100644 --- a/cli/cycle-monitor.html +++ b/cli/cycle-monitor.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-monitor

    -
    Focus the monitor in the given cycle direction
+
    Focus the monitor in the given cycle direction
 
 Usage: komorebic.exe cycle-monitor <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cycle-move-to-monitor.html b/cli/cycle-move-to-monitor.html index 1ba89526..3f738bf6 100644 --- a/cli/cycle-move-to-monitor.html +++ b/cli/cycle-move-to-monitor.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-move-to-monitor

    -
    Move the focused window to the monitor in the given cycle direction
+
    Move the focused window to the monitor in the given cycle direction
 
 Usage: komorebic.exe cycle-move-to-monitor <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cycle-move-to-workspace.html b/cli/cycle-move-to-workspace.html index e01861f6..716c9e44 100644 --- a/cli/cycle-move-to-workspace.html +++ b/cli/cycle-move-to-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-move-to-workspace

    -
    Move the focused window to the workspace in the given cycle direction
+
    Move the focused window to the workspace in the given cycle direction
 
 Usage: komorebic.exe cycle-move-to-workspace <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cycle-move.html b/cli/cycle-move.html index a356a028..2ee2d373 100644 --- a/cli/cycle-move.html +++ b/cli/cycle-move.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-move

    -
    Move the focused window in the specified cycle direction
+
    Move the focused window in the specified cycle direction
 
 Usage: komorebic.exe cycle-move <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cycle-send-to-monitor.html b/cli/cycle-send-to-monitor.html index c2d3a2e8..65b7b241 100644 --- a/cli/cycle-send-to-monitor.html +++ b/cli/cycle-send-to-monitor.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-send-to-monitor

    -
    Send the focused window to the monitor in the given cycle direction
+
    Send the focused window to the monitor in the given cycle direction
 
 Usage: komorebic.exe cycle-send-to-monitor <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cycle-send-to-workspace.html b/cli/cycle-send-to-workspace.html index d5feb700..c902566a 100644 --- a/cli/cycle-send-to-workspace.html +++ b/cli/cycle-send-to-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-send-to-workspace

    -
    Send the focused window to the workspace in the given cycle direction
+
    Send the focused window to the workspace in the given cycle direction
 
 Usage: komorebic.exe cycle-send-to-workspace <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cycle-stack.html b/cli/cycle-stack.html index 78989816..04e44d5f 100644 --- a/cli/cycle-stack.html +++ b/cli/cycle-stack.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-stack

    -
    Cycle the focused stack in the specified cycle direction
+
    Cycle the focused stack in the specified cycle direction
 
 Usage: komorebic.exe cycle-stack <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/cycle-workspace.html b/cli/cycle-workspace.html index ba52ef4b..d6ea22f9 100644 --- a/cli/cycle-workspace.html +++ b/cli/cycle-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    cycle-workspace

    -
    Focus the workspace in the given cycle direction
+
    Focus the workspace in the given cycle direction
 
 Usage: komorebic.exe cycle-workspace <CYCLE_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/disable-autostart.html b/cli/disable-autostart.html index f78258a3..d1c582ef 100644 --- a/cli/disable-autostart.html +++ b/cli/disable-autostart.html @@ -470,6 +470,8 @@ + +
  • @@ -538,6 +540,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4033,15 +4055,14 @@

    disable-autostart

    -
    Deletes the komorebi.lnk shortcut in shell:startup to disable autostart
+
    Deletes the komorebi.lnk shortcut in shell:startup to disable autostart
 
 Usage: komorebic.exe disable-autostart
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/display-index-preference.html b/cli/display-index-preference.html index 7c46e50b..1009a99b 100644 --- a/cli/display-index-preference.html +++ b/cli/display-index-preference.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    display-index-preference

    -
    Set the display index preference for a monitor identified using its display name
+
    Set the display index preference for a monitor identified using its display name
 
 Usage: komorebic.exe display-index-preference <INDEX_PREFERENCE> <DISPLAY>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/enable-autostart.html b/cli/enable-autostart.html index d32950b2..6cdeef80 100644 --- a/cli/enable-autostart.html +++ b/cli/enable-autostart.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    enable-autostart

    -
    Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi
+
    Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi
 
 Usage: komorebic.exe enable-autostart [OPTIONS]
 
@@ -4044,7 +4066,7 @@ Options:
           Path to a static configuration JSON file
 
   -f, --ffm
-          Enable komorebi's custom focus-follows-mouse implementation
+          Enable komorebi's custom focus-follows-mouse implementation
 
       --whkd
           Enable autostart of whkd
@@ -4054,8 +4076,7 @@ Options:
 
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/ensure-named-workspaces.html b/cli/ensure-named-workspaces.html index ae12bdd0..6730c7ea 100644 --- a/cli/ensure-named-workspaces.html +++ b/cli/ensure-named-workspaces.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    ensure-named-workspaces

    -
    Create these many named workspaces for the specified monitor
+
    Create these many named workspaces for the specified monitor
 
 Usage: komorebic.exe ensure-named-workspaces <MONITOR> [NAMES]...
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/ensure-workspaces.html b/cli/ensure-workspaces.html index c6f31a69..8dd6d5df 100644 --- a/cli/ensure-workspaces.html +++ b/cli/ensure-workspaces.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    ensure-workspaces

    -
    Create at least this many workspaces for the specified monitor
+
    Create at least this many workspaces for the specified monitor
 
 Usage: komorebic.exe ensure-workspaces <MONITOR> <WORKSPACE_COUNT>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/fetch-app-specific-configuration.html b/cli/fetch-app-specific-configuration.html index d7edcb2c..b9e4b2d6 100644 --- a/cli/fetch-app-specific-configuration.html +++ b/cli/fetch-app-specific-configuration.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    fetch-app-specific-configuration

    -
    Fetch the latest version of applications.yaml from komorebi-application-specific-configuration
+
    Fetch the latest version of applications.yaml from komorebi-application-specific-configuration
 
 Usage: komorebic.exe fetch-app-specific-configuration
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/flip-layout.html b/cli/flip-layout.html index 604add90..4ee426d3 100644 --- a/cli/flip-layout.html +++ b/cli/flip-layout.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    flip-layout

    -
    Flip the layout on the focused workspace (BSP only)
+
    Flip the layout on the focused workspace (BSP only)
 
 Usage: komorebic.exe flip-layout <AXIS>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/float-rule.html b/cli/float-rule.html index 5144d589..525bf043 100644 --- a/cli/float-rule.html +++ b/cli/float-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    float-rule

    -
    Add a rule to always float the specified application
+
    Add a rule to always float the specified application
 
 Usage: komorebic.exe float-rule <IDENTIFIER> <ID>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/focus-follows-mouse.html b/cli/focus-follows-mouse.html index 05cfb140..09779a05 100644 --- a/cli/focus-follows-mouse.html +++ b/cli/focus-follows-mouse.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    focus-follows-mouse

    -
    Enable or disable focus follows mouse for the operating system
+
    Enable or disable focus follows mouse for the operating system
 
 Usage: komorebic.exe focus-follows-mouse [OPTIONS] <BOOLEAN_STATE>
 
@@ -4052,9 +4074,8 @@ Options:
           - windows:  The native (legacy) Windows FFM implementation
 
   -h, --help
-          Print help (see a summary with '-h')
-
-
    
+          Print help (see a summary with '-h')
+
    diff --git a/cli/focus-last-workspace.html b/cli/focus-last-workspace.html index 50970b0b..cd356cc4 100644 --- a/cli/focus-last-workspace.html +++ b/cli/focus-last-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    focus-last-workspace

    -
    Focus the last focused workspace on the focused monitor
+
    Focus the last focused workspace on the focused monitor
 
 Usage: komorebic.exe focus-last-workspace
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/focus-monitor-workspace.html b/cli/focus-monitor-workspace.html index 521a6a84..4952037f 100644 --- a/cli/focus-monitor-workspace.html +++ b/cli/focus-monitor-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    focus-monitor-workspace

    -
    Focus the specified workspace on the target monitor
+
    Focus the specified workspace on the target monitor
 
 Usage: komorebic.exe focus-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/focus-monitor.html b/cli/focus-monitor.html index 0c9c296b..8878ae21 100644 --- a/cli/focus-monitor.html +++ b/cli/focus-monitor.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    focus-monitor

    -
    Focus the specified monitor
+
    Focus the specified monitor
 
 Usage: komorebic.exe focus-monitor <TARGET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/focus-named-workspace.html b/cli/focus-named-workspace.html index 07d78636..128e14df 100644 --- a/cli/focus-named-workspace.html +++ b/cli/focus-named-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    focus-named-workspace

    -
    Focus the specified workspace
+
    Focus the specified workspace
 
 Usage: komorebic.exe focus-named-workspace <WORKSPACE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/focus-workspace.html b/cli/focus-workspace.html index ad264dc9..c7800e4d 100644 --- a/cli/focus-workspace.html +++ b/cli/focus-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    focus-workspace

    -
    Focus the specified workspace on the focused monitor
+
    Focus the specified workspace on the focused monitor
 
 Usage: komorebic.exe focus-workspace <TARGET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/focus-workspaces.html b/cli/focus-workspaces.html index 69a2f1ff..d58a7f3f 100644 --- a/cli/focus-workspaces.html +++ b/cli/focus-workspaces.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    focus-workspaces

    -
    Focus the specified workspace on all monitors
+
    Focus the specified workspace on all monitors
 
 Usage: komorebic.exe focus-workspaces <TARGET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/focus.html b/cli/focus.html index 680c79f0..29e59af4 100644 --- a/cli/focus.html +++ b/cli/focus.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    focus

    -
    Change focus to the window in the specified direction
+
    Change focus to the window in the specified direction
 
 Usage: komorebic.exe focus <OPERATION_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/focused-workspace-container-padding.html b/cli/focused-workspace-container-padding.html index 5a76988a..2447149b 100644 --- a/cli/focused-workspace-container-padding.html +++ b/cli/focused-workspace-container-padding.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    focused-workspace-container-padding

    -
    Set container padding on the focused workspace
+
    Set container padding on the focused workspace
 
 Usage: komorebic.exe focused-workspace-container-padding <SIZE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/focused-workspace-padding.html b/cli/focused-workspace-padding.html index eecaf648..ce0aaf30 100644 --- a/cli/focused-workspace-padding.html +++ b/cli/focused-workspace-padding.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    focused-workspace-padding

    -
    Set workspace padding on the focused workspace
+
    Set workspace padding on the focused workspace
 
 Usage: komorebic.exe focused-workspace-padding <SIZE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/force-focus.html b/cli/force-focus.html index 737abd96..34bb74df 100644 --- a/cli/force-focus.html +++ b/cli/force-focus.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    force-focus

    -
    Forcibly focus the window at the cursor with a left mouse click
+
    Forcibly focus the window at the cursor with a left mouse click
 
 Usage: komorebic.exe force-focus
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/format-app-specific-configuration.html b/cli/format-app-specific-configuration.html index 78281ef3..81d17c25 100644 --- a/cli/format-app-specific-configuration.html +++ b/cli/format-app-specific-configuration.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    format-app-specific-configuration

    -
    Format a YAML file for use with the 'ahk-app-specific-configuration' command
+
    Format a YAML file for use with the 'ahk-app-specific-configuration' command
 
 Usage: komorebic.exe format-app-specific-configuration <PATH>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/generate-static-config.html b/cli/generate-static-config.html index 72aed81f..84c5f900 100644 --- a/cli/generate-static-config.html +++ b/cli/generate-static-config.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    generate-static-config

    -
    Generates a static configuration JSON file based on the current window manager state
+
    Generates a static configuration JSON file based on the current window manager state
 
 Usage: komorebic.exe generate-static-config
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/global-state.html b/cli/global-state.html index 6ce3db57..e47335e3 100644 --- a/cli/global-state.html +++ b/cli/global-state.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    global-state

    -
    Show a JSON representation of the current global state
+
    Show a JSON representation of the current global state
 
 Usage: komorebic.exe global-state
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/global-work-area-offset.html b/cli/global-work-area-offset.html index 7712a9ba..6aaf4363 100644 --- a/cli/global-work-area-offset.html +++ b/cli/global-work-area-offset.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    global-work-area-offset

    -
    Set offsets to exclude parts of the work area from tiling
+
    Set offsets to exclude parts of the work area from tiling
 
 Usage: komorebic.exe global-work-area-offset <LEFT> <TOP> <RIGHT> <BOTTOM>
 
@@ -4055,8 +4077,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/identify-layered-application.html b/cli/identify-layered-application.html index c77d2226..f7ed2e41 100644 --- a/cli/identify-layered-application.html +++ b/cli/identify-layered-application.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    identify-layered-application

    -
    Identify an application that has WS_EX_LAYERED, but should still be managed
+
    Identify an application that has WS_EX_LAYERED, but should still be managed
 
 Usage: komorebic.exe identify-layered-application <IDENTIFIER> <ID>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/identify-object-name-change-application.html b/cli/identify-object-name-change-application.html index 4307891a..f72c304b 100644 --- a/cli/identify-object-name-change-application.html +++ b/cli/identify-object-name-change-application.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    identify-object-name-change-application

    -
    Identify an application that sends EVENT_OBJECT_NAMECHANGE on launch
+
    Identify an application that sends EVENT_OBJECT_NAMECHANGE on launch
 
 Usage: komorebic.exe identify-object-name-change-application <IDENTIFIER> <ID>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/identify-tray-application.html b/cli/identify-tray-application.html index b2331cf4..153f5d77 100644 --- a/cli/identify-tray-application.html +++ b/cli/identify-tray-application.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    identify-tray-application

    -
    Identify an application that closes to the system tray
+
    Identify an application that closes to the system tray
 
 Usage: komorebic.exe identify-tray-application <IDENTIFIER> <ID>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/initial-named-workspace-rule.html b/cli/initial-named-workspace-rule.html index c387ddb3..0900c060 100644 --- a/cli/initial-named-workspace-rule.html +++ b/cli/initial-named-workspace-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    initial-named-workspace-rule

    -
    Add a rule to associate an application with a named workspace on first show
+
    Add a rule to associate an application with a named workspace on first show
 
 Usage: komorebic.exe initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/initial-workspace-rule.html b/cli/initial-workspace-rule.html index 5b635606..baa64167 100644 --- a/cli/initial-workspace-rule.html +++ b/cli/initial-workspace-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    initial-workspace-rule

    -
    Add a rule to associate an application with a workspace on first show
+
    Add a rule to associate an application with a workspace on first show
 
 Usage: komorebic.exe initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
 
@@ -4055,8 +4077,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/invisible-borders.html b/cli/invisible-borders.html index 4416226b..d0a8dae5 100644 --- a/cli/invisible-borders.html +++ b/cli/invisible-borders.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    invisible-borders

    -
    Set the invisible border dimensions around each window
+
    Set the invisible border dimensions around each window
 
 Usage: komorebic.exe invisible-borders <LEFT> <TOP> <RIGHT> <BOTTOM>
 
@@ -4055,8 +4077,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/load-custom-layout.html b/cli/load-custom-layout.html index c35e7471..fc02fc98 100644 --- a/cli/load-custom-layout.html +++ b/cli/load-custom-layout.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    load-custom-layout

    -
    Load a custom layout from file for the focused workspace
+
    Load a custom layout from file for the focused workspace
 
 Usage: komorebic.exe load-custom-layout <PATH>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/load-resize.html b/cli/load-resize.html index e1bfaa59..dbe26cb2 100644 --- a/cli/load-resize.html +++ b/cli/load-resize.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    load-resize

    -
    Load the resize layout dimensions from a file
+
    Load the resize layout dimensions from a file
 
 Usage: komorebic.exe load-resize <PATH>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/log.html b/cli/log.html index 012f8e60..10e3b0b8 100644 --- a/cli/log.html +++ b/cli/log.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    log

    -
    Tail komorebi.exe's process logs (cancel with Ctrl-C)
+
    Tail komorebi.exe's process logs (cancel with Ctrl-C)
 
 Usage: komorebic.exe log
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/manage-rule.html b/cli/manage-rule.html index bcf5e57b..badbe746 100644 --- a/cli/manage-rule.html +++ b/cli/manage-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    manage-rule

    -
    Add a rule to always manage the specified application
+
    Add a rule to always manage the specified application
 
 Usage: komorebic.exe manage-rule <IDENTIFIER> <ID>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/manage.html b/cli/manage.html index 4032725e..6aab7310 100644 --- a/cli/manage.html +++ b/cli/manage.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    manage

    -
    Force komorebi to manage the focused window
+
    Force komorebi to manage the focused window
 
 Usage: komorebic.exe manage
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/minimize.html b/cli/minimize.html index 2bcf3f51..f8f33c22 100644 --- a/cli/minimize.html +++ b/cli/minimize.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    minimize

    -
    Minimize the focused window
+
    Minimize the focused window
 
 Usage: komorebic.exe minimize
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/monitor-index-preference.html b/cli/monitor-index-preference.html index 0960512d..42f03369 100644 --- a/cli/monitor-index-preference.html +++ b/cli/monitor-index-preference.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    monitor-index-preference

    -
    Set the monitor index preference for a monitor identified using its size
+
    Set the monitor index preference for a monitor identified using its size
 
 Usage: komorebic.exe monitor-index-preference <INDEX_PREFERENCE> <LEFT> <TOP> <RIGHT> <BOTTOM>
 
@@ -4044,22 +4066,21 @@ Arguments:
           Preferred monitor index (zero-indexed)
 
   <LEFT>
-          Left value of the monitor's size Rect
+          Left value of the monitor's size Rect
 
   <TOP>
-          Top value of the monitor's size Rect
+          Top value of the monitor's size Rect
 
   <RIGHT>
-          Right value of the monitor's size Rect
+          Right value of the monitor's size Rect
 
   <BOTTOM>
-          Bottom value of the monitor's size Rect
+          Bottom value of the monitor's size Rect
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/monitor-work-area-offset.html b/cli/monitor-work-area-offset.html index 027644da..f05c034a 100644 --- a/cli/monitor-work-area-offset.html +++ b/cli/monitor-work-area-offset.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    monitor-work-area-offset

    -
    Set offsets for a monitor to exclude parts of the work area from tiling
+
    Set offsets for a monitor to exclude parts of the work area from tiling
 
 Usage: komorebic.exe monitor-work-area-offset <MONITOR> <LEFT> <TOP> <RIGHT> <BOTTOM>
 
@@ -4058,8 +4080,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/mouse-follows-focus.html b/cli/mouse-follows-focus.html index f9ca1c8d..13cf6f1e 100644 --- a/cli/mouse-follows-focus.html +++ b/cli/mouse-follows-focus.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    mouse-follows-focus

    -
    Enable or disable mouse follows focus on all workspaces
+
    Enable or disable mouse follows focus on all workspaces
 
 Usage: komorebic.exe mouse-follows-focus <BOOLEAN_STATE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/move-to-monitor-workspace.html b/cli/move-to-monitor-workspace.html index 68fc0749..a16c2030 100644 --- a/cli/move-to-monitor-workspace.html +++ b/cli/move-to-monitor-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    move-to-monitor-workspace

    -
    Move the focused window to the specified monitor workspace
+
    Move the focused window to the specified monitor workspace
 
 Usage: komorebic.exe move-to-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/move-to-monitor.html b/cli/move-to-monitor.html index 8e1f2b80..35d99879 100644 --- a/cli/move-to-monitor.html +++ b/cli/move-to-monitor.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    move-to-monitor

    -
    Move the focused window to the specified monitor
+
    Move the focused window to the specified monitor
 
 Usage: komorebic.exe move-to-monitor <TARGET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/move-to-named-workspace.html b/cli/move-to-named-workspace.html index 3dd8d4e8..7de8b8b5 100644 --- a/cli/move-to-named-workspace.html +++ b/cli/move-to-named-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    move-to-named-workspace

    -
    Move the focused window to the specified workspace
+
    Move the focused window to the specified workspace
 
 Usage: komorebic.exe move-to-named-workspace <WORKSPACE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/move-to-workspace.html b/cli/move-to-workspace.html index aabc186d..afb68dd8 100644 --- a/cli/move-to-workspace.html +++ b/cli/move-to-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    move-to-workspace

    -
    Move the focused window to the specified workspace
+
    Move the focused window to the specified workspace
 
 Usage: komorebic.exe move-to-workspace <TARGET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/move-workspace-to-monitor.html b/cli/move-workspace-to-monitor.html index 4096fddb..6f126237 100644 --- a/cli/move-workspace-to-monitor.html +++ b/cli/move-workspace-to-monitor.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    move-workspace-to-monitor

    -
    Move the focused workspace to the specified monitor
+
    Move the focused workspace to the specified monitor
 
 Usage: komorebic.exe move-workspace-to-monitor <TARGET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/move.html b/cli/move.html index 57285370..6db6969c 100644 --- a/cli/move.html +++ b/cli/move.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    move

    -
    Move the focused window in the specified direction
+
    Move the focused window in the specified direction
 
 Usage: komorebic.exe move <OPERATION_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/named-workspace-container-padding.html b/cli/named-workspace-container-padding.html index 36f4fdc8..f5a5ce62 100644 --- a/cli/named-workspace-container-padding.html +++ b/cli/named-workspace-container-padding.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    named-workspace-container-padding

    -
    Set the container padding for the specified workspace
+
    Set the container padding for the specified workspace
 
 Usage: komorebic.exe named-workspace-container-padding <WORKSPACE> <SIZE>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/named-workspace-custom-layout-rule.html b/cli/named-workspace-custom-layout-rule.html index ea439fed..913866a1 100644 --- a/cli/named-workspace-custom-layout-rule.html +++ b/cli/named-workspace-custom-layout-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    named-workspace-custom-layout-rule

    -
    Add a dynamic custom layout for the specified workspace
+
    Add a dynamic custom layout for the specified workspace
 
 Usage: komorebic.exe named-workspace-custom-layout-rule <WORKSPACE> <AT_CONTAINER_COUNT> <PATH>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/named-workspace-custom-layout.html b/cli/named-workspace-custom-layout.html index 8bba2a0d..e0563bed 100644 --- a/cli/named-workspace-custom-layout.html +++ b/cli/named-workspace-custom-layout.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    named-workspace-custom-layout

    -
    Set a custom layout for the specified workspace
+
    Set a custom layout for the specified workspace
 
 Usage: komorebic.exe named-workspace-custom-layout <WORKSPACE> <PATH>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/named-workspace-layout-rule.html b/cli/named-workspace-layout-rule.html index 15619cf4..41f18883 100644 --- a/cli/named-workspace-layout-rule.html +++ b/cli/named-workspace-layout-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    named-workspace-layout-rule

    -
    Add a dynamic layout rule for the specified workspace
+
    Add a dynamic layout rule for the specified workspace
 
 Usage: komorebic.exe named-workspace-layout-rule <WORKSPACE> <AT_CONTAINER_COUNT> <LAYOUT>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/named-workspace-layout.html b/cli/named-workspace-layout.html index 3918aa7a..1112600d 100644 --- a/cli/named-workspace-layout.html +++ b/cli/named-workspace-layout.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    named-workspace-layout

    -
    Set the layout for the specified workspace
+
    Set the layout for the specified workspace
 
 Usage: komorebic.exe named-workspace-layout <WORKSPACE> <VALUE>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/named-workspace-padding.html b/cli/named-workspace-padding.html index 1cb4d19d..9abd37f4 100644 --- a/cli/named-workspace-padding.html +++ b/cli/named-workspace-padding.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    named-workspace-padding

    -
    Set the workspace padding for the specified workspace
+
    Set the workspace padding for the specified workspace
 
 Usage: komorebic.exe named-workspace-padding <WORKSPACE> <SIZE>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/named-workspace-rule.html b/cli/named-workspace-rule.html index b714a5f3..6868dedc 100644 --- a/cli/named-workspace-rule.html +++ b/cli/named-workspace-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    named-workspace-rule

    -
    Add a rule to associate an application with a named workspace
+
    Add a rule to associate an application with a named workspace
 
 Usage: komorebic.exe named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/named-workspace-tiling.html b/cli/named-workspace-tiling.html index deeb207f..9f4d41a3 100644 --- a/cli/named-workspace-tiling.html +++ b/cli/named-workspace-tiling.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    named-workspace-tiling

    -
    Enable or disable window tiling for the specified workspace
+
    Enable or disable window tiling for the specified workspace
 
 Usage: komorebic.exe named-workspace-tiling <WORKSPACE> <VALUE>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/new-workspace.html b/cli/new-workspace.html index 1cb4095f..4bffa17d 100644 --- a/cli/new-workspace.html +++ b/cli/new-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    new-workspace

    -
    Create and append a new workspace on the focused monitor
+
    Create and append a new workspace on the focused monitor
 
 Usage: komorebic.exe new-workspace
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/notification-schema.html b/cli/notification-schema.html index 97cf8804..708d14de 100644 --- a/cli/notification-schema.html +++ b/cli/notification-schema.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    notification-schema

    -
    Generate a JSON Schema of subscription notifications
+
    Generate a JSON Schema of subscription notifications
 
 Usage: komorebic.exe notification-schema
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/promote-focus.html b/cli/promote-focus.html index 29689867..869baf95 100644 --- a/cli/promote-focus.html +++ b/cli/promote-focus.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    promote-focus

    -
    Promote the user focus to the top of the tree
+
    Promote the user focus to the top of the tree
 
 Usage: komorebic.exe promote-focus
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/promote.html b/cli/promote.html index 0133036c..95ac1e9e 100644 --- a/cli/promote.html +++ b/cli/promote.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    promote

    -
    Promote the focused window to the top of the tree
+
    Promote the focused window to the top of the tree
 
 Usage: komorebic.exe promote
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/pwsh-app-specific-configuration.html b/cli/pwsh-app-specific-configuration.html index c4581783..f6cf4a44 100644 --- a/cli/pwsh-app-specific-configuration.html +++ b/cli/pwsh-app-specific-configuration.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    pwsh-app-specific-configuration

    -
    Generate common app-specific configurations and fixes in a PowerShell script
+
    Generate common app-specific configurations and fixes in a PowerShell script
 
 Usage: komorebic.exe pwsh-app-specific-configuration <PATH> [OVERRIDE_PATH]
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/query.html b/cli/query.html index 9a541ebf..8cfe5bd6 100644 --- a/cli/query.html +++ b/cli/query.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    query

    -
    Query the current window manager state
+
    Query the current window manager state
 
 Usage: komorebic.exe query <STATE_QUERY>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/quick-load-resize.html b/cli/quick-load-resize.html index ced03313..4fde89db 100644 --- a/cli/quick-load-resize.html +++ b/cli/quick-load-resize.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    quick-load-resize

    -
    Load the last quicksaved resize layout dimensions
+
    Load the last quicksaved resize layout dimensions
 
 Usage: komorebic.exe quick-load-resize
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/quick-save-resize.html b/cli/quick-save-resize.html index ab20ea33..edfc5825 100644 --- a/cli/quick-save-resize.html +++ b/cli/quick-save-resize.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    quick-save-resize

    -
    Quicksave the current resize layout dimensions
+
    Quicksave the current resize layout dimensions
 
 Usage: komorebic.exe quick-save-resize
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/quickstart.html b/cli/quickstart.html index 3b55f2d8..1d5b4ec4 100644 --- a/cli/quickstart.html +++ b/cli/quickstart.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    quickstart

    -
    Gather example configurations for a new-user quickstart
+
    Gather example configurations for a new-user quickstart
 
 Usage: komorebic.exe quickstart
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/reload-configuration.html b/cli/reload-configuration.html index 096725bc..4152c79a 100644 --- a/cli/reload-configuration.html +++ b/cli/reload-configuration.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    reload-configuration

    -
    Reload ~/komorebi.ahk (if it exists)
+
    Reload ~/komorebi.ahk (if it exists)
 
 Usage: komorebic.exe reload-configuration
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/remove-title-bar.html b/cli/remove-title-bar.html index 18d7d935..aab623a8 100644 --- a/cli/remove-title-bar.html +++ b/cli/remove-title-bar.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    remove-title-bar

    -
    Whitelist an application for title bar removal
+
    Whitelist an application for title bar removal
 
 Usage: komorebic.exe remove-title-bar <IDENTIFIER> <ID>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/resize-axis.html b/cli/resize-axis.html index cadbbcdf..8fb6b742 100644 --- a/cli/resize-axis.html +++ b/cli/resize-axis.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    resize-axis

    -
    Resize the focused window or primary column along the specified axis
+
    Resize the focused window or primary column along the specified axis
 
 Usage: komorebic.exe resize-axis <AXIS> <SIZING>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/resize-delta.html b/cli/resize-delta.html index d5b6b9ba..0b558983 100644 --- a/cli/resize-delta.html +++ b/cli/resize-delta.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    resize-delta

    -
    Set the resize delta (used by resize-edge and resize-axis)
+
    Set the resize delta (used by resize-edge and resize-axis)
 
 Usage: komorebic.exe resize-delta <PIXELS>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/resize-edge.html b/cli/resize-edge.html index e1af01c9..cfb4ca8c 100644 --- a/cli/resize-edge.html +++ b/cli/resize-edge.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    resize-edge

    -
    Resize the focused window in the specified direction
+
    Resize the focused window in the specified direction
 
 Usage: komorebic.exe resize-edge <EDGE> <SIZING>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/restore-windows.html b/cli/restore-windows.html index 856ec4b0..baaaf5f1 100644 --- a/cli/restore-windows.html +++ b/cli/restore-windows.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    restore-windows

    -
    Restore all hidden windows (debugging command)
+
    Restore all hidden windows (debugging command)
 
 Usage: komorebic.exe restore-windows
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/retile.html b/cli/retile.html index 80e29060..c37f49e3 100644 --- a/cli/retile.html +++ b/cli/retile.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    retile

    -
    Force the retiling of all managed windows
+
    Force the retiling of all managed windows
 
 Usage: komorebic.exe retile
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/save-resize.html b/cli/save-resize.html index 51ce64eb..e8d822bd 100644 --- a/cli/save-resize.html +++ b/cli/save-resize.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    save-resize

    -
    Save the current resize layout dimensions to a file
+
    Save the current resize layout dimensions to a file
 
 Usage: komorebic.exe save-resize <PATH>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/send-to-monitor-workspace.html b/cli/send-to-monitor-workspace.html index 6723e6f2..af429121 100644 --- a/cli/send-to-monitor-workspace.html +++ b/cli/send-to-monitor-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    send-to-monitor-workspace

    -
    Send the focused window to the specified monitor workspace
+
    Send the focused window to the specified monitor workspace
 
 Usage: komorebic.exe send-to-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>
 
@@ -4049,8 +4071,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/send-to-monitor.html b/cli/send-to-monitor.html index a383805b..aecd1efc 100644 --- a/cli/send-to-monitor.html +++ b/cli/send-to-monitor.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    send-to-monitor

    -
    Send the focused window to the specified monitor
+
    Send the focused window to the specified monitor
 
 Usage: komorebic.exe send-to-monitor <TARGET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/send-to-named-workspace.html b/cli/send-to-named-workspace.html index 86287574..cf2ea025 100644 --- a/cli/send-to-named-workspace.html +++ b/cli/send-to-named-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    send-to-named-workspace

    -
    Send the focused window to the specified workspace
+
    Send the focused window to the specified workspace
 
 Usage: komorebic.exe send-to-named-workspace <WORKSPACE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/send-to-workspace.html b/cli/send-to-workspace.html index 94c1165c..36fb3ec9 100644 --- a/cli/send-to-workspace.html +++ b/cli/send-to-workspace.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    send-to-workspace

    -
    Send the focused window to the specified workspace
+
    Send the focused window to the specified workspace
 
 Usage: komorebic.exe send-to-workspace <TARGET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/socket-schema.html b/cli/socket-schema.html index f39820e0..48a26798 100644 --- a/cli/socket-schema.html +++ b/cli/socket-schema.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    socket-schema

    -
    Generate a JSON Schema of socket messages
+
    Generate a JSON Schema of socket messages
 
 Usage: komorebic.exe socket-schema
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/stack.html b/cli/stack.html index ca1a81be..9d98c7a8 100644 --- a/cli/stack.html +++ b/cli/stack.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    stack

    -
    Stack the focused window in the specified direction
+
    Stack the focused window in the specified direction
 
 Usage: komorebic.exe stack <OPERATION_DIRECTION>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/start.html b/cli/start.html index bf8b23e3..bc74145c 100644 --- a/cli/start.html +++ b/cli/start.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,19 +4057,19 @@

    start

    -
    Start komorebi.exe as a background process
+
    Start komorebi.exe as a background process
 
 Usage: komorebic.exe start [OPTIONS]
 
 Options:
   -f, --ffm
-          Allow the use of komorebi's custom focus-follows-mouse implementation
+          Allow the use of komorebi's custom focus-follows-mouse implementation
 
   -c, --config <CONFIG>
           Path to a static configuration JSON file
 
   -a, --await-configuration
-          Wait for 'komorebic complete-configuration' to be sent before processing events
+          Wait for 'komorebic complete-configuration' to be sent before processing events
 
   -t, --tcp-port <TCP_PORT>
           Start a TCP server on the given port to allow the direct sending of SocketMessages
@@ -4060,8 +4082,7 @@ Options:
 
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/state.html b/cli/state.html index 34daf3e7..035ba267 100644 --- a/cli/state.html +++ b/cli/state.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    state

    -
    Show a JSON representation of the current window manager state
+
    Show a JSON representation of the current window manager state
 
 Usage: komorebic.exe state
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/static-config-schema.html b/cli/static-config-schema.html index 94429f81..aae3c9df 100644 --- a/cli/static-config-schema.html +++ b/cli/static-config-schema.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    static-config-schema

    -
    Generate a JSON Schema of the static configuration file
+
    Generate a JSON Schema of the static configuration file
 
 Usage: komorebic.exe static-config-schema
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/stop.html b/cli/stop.html index faf976fb..23e80714 100644 --- a/cli/stop.html +++ b/cli/stop.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    stop

    -
    Stop the komorebi.exe process and restore all hidden windows
+
    Stop the komorebi.exe process and restore all hidden windows
 
 Usage: komorebic.exe stop [OPTIONS]
 
@@ -4045,8 +4067,7 @@ Options:
 
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/subscribe-pipe.html b/cli/subscribe-pipe.html index ae40be7d..0a9fa736 100644 --- a/cli/subscribe-pipe.html +++ b/cli/subscribe-pipe.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    subscribe-pipe

    -
    Subscribe to komorebi events using a Named Pipe
+
    Subscribe to komorebi events using a Named Pipe
 
 Usage: komorebic.exe subscribe-pipe <NAMED_PIPE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/subscribe-socket.html b/cli/subscribe-socket.html index 73787351..e7c68e62 100644 --- a/cli/subscribe-socket.html +++ b/cli/subscribe-socket.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    subscribe-socket

    -
    Subscribe to komorebi events using a Unix Domain Socket
+
    Subscribe to komorebi events using a Unix Domain Socket
 
 Usage: komorebic.exe subscribe-socket <SOCKET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/swap-workspaces-with-monitor.html b/cli/swap-workspaces-with-monitor.html index 6c5e2706..89060b9c 100644 --- a/cli/swap-workspaces-with-monitor.html +++ b/cli/swap-workspaces-with-monitor.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    swap-workspaces-with-monitor

    -
    Swap focused monitor workspaces with specified monitor
+
    Swap focused monitor workspaces with specified monitor
 
 Usage: komorebic.exe swap-workspaces-with-monitor <TARGET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/toggle-cross-monitor-move-behaviour.html b/cli/toggle-cross-monitor-move-behaviour.html index f5f92df9..c916227e 100644 --- a/cli/toggle-cross-monitor-move-behaviour.html +++ b/cli/toggle-cross-monitor-move-behaviour.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    toggle-cross-monitor-move-behaviour

    -
    Toggle the behaviour when moving windows across monitor boundaries
+
    Toggle the behaviour when moving windows across monitor boundaries
 
 Usage: komorebic.exe toggle-cross-monitor-move-behaviour
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/toggle-float.html b/cli/toggle-float.html index 5dc8f4ca..2883b4ef 100644 --- a/cli/toggle-float.html +++ b/cli/toggle-float.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    toggle-float

    -
    Toggle floating mode for the focused window
+
    Toggle floating mode for the focused window
 
 Usage: komorebic.exe toggle-float
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/toggle-focus-follows-mouse.html b/cli/toggle-focus-follows-mouse.html index a075605e..3066bcc8 100644 --- a/cli/toggle-focus-follows-mouse.html +++ b/cli/toggle-focus-follows-mouse.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    toggle-focus-follows-mouse

    -
    Toggle focus follows mouse for the operating system
+
    Toggle focus follows mouse for the operating system
 
 Usage: komorebic.exe toggle-focus-follows-mouse [OPTIONS]
 
@@ -4048,9 +4070,8 @@ Options:
           - windows:  The native (legacy) Windows FFM implementation
 
   -h, --help
-          Print help (see a summary with '-h')
-
-
    
+          Print help (see a summary with '-h')
+
    diff --git a/cli/toggle-maximize.html b/cli/toggle-maximize.html index a66dc005..ec57b9f1 100644 --- a/cli/toggle-maximize.html +++ b/cli/toggle-maximize.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    toggle-maximize

    -
    Toggle native maximization for the focused window
+
    Toggle native maximization for the focused window
 
 Usage: komorebic.exe toggle-maximize
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/toggle-monocle.html b/cli/toggle-monocle.html index ae4abf2d..63a2f8a3 100644 --- a/cli/toggle-monocle.html +++ b/cli/toggle-monocle.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    toggle-monocle

    -
    Toggle monocle mode for the focused container
+
    Toggle monocle mode for the focused container
 
 Usage: komorebic.exe toggle-monocle
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/toggle-mouse-follows-focus.html b/cli/toggle-mouse-follows-focus.html index dade499e..165b565e 100644 --- a/cli/toggle-mouse-follows-focus.html +++ b/cli/toggle-mouse-follows-focus.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    toggle-mouse-follows-focus

    -
    Toggle mouse follows focus on all workspaces
+
    Toggle mouse follows focus on all workspaces
 
 Usage: komorebic.exe toggle-mouse-follows-focus
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/toggle-pause.html b/cli/toggle-pause.html index 0e0645f1..32e8dce5 100644 --- a/cli/toggle-pause.html +++ b/cli/toggle-pause.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    toggle-pause

    -
    Toggle window tiling on the focused workspace
+
    Toggle window tiling on the focused workspace
 
 Usage: komorebic.exe toggle-pause
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/toggle-tiling.html b/cli/toggle-tiling.html index fbee1fda..3050ae5d 100644 --- a/cli/toggle-tiling.html +++ b/cli/toggle-tiling.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    toggle-tiling

    -
    Toggle window tiling on the focused workspace
+
    Toggle window tiling on the focused workspace
 
 Usage: komorebic.exe toggle-tiling
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/toggle-title-bars.html b/cli/toggle-title-bars.html index 0c469a50..9cde751d 100644 --- a/cli/toggle-title-bars.html +++ b/cli/toggle-title-bars.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    toggle-title-bars

    -
    Toggle title bars for whitelisted applications
+
    Toggle title bars for whitelisted applications
 
 Usage: komorebic.exe toggle-title-bars
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/toggle-window-container-behaviour.html b/cli/toggle-window-container-behaviour.html index 62b3caa3..8565b111 100644 --- a/cli/toggle-window-container-behaviour.html +++ b/cli/toggle-window-container-behaviour.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    toggle-window-container-behaviour

    -
    Toggle the behaviour for new windows (stacking or dynamic tiling)
+
    Toggle the behaviour for new windows (stacking or dynamic tiling)
 
 Usage: komorebic.exe toggle-window-container-behaviour
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/unmanage.html b/cli/unmanage.html index 2045e5e3..ba03cdfb 100644 --- a/cli/unmanage.html +++ b/cli/unmanage.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    unmanage

    -
    Unmanage a window that was forcibly managed
+
    Unmanage a window that was forcibly managed
 
 Usage: komorebic.exe unmanage
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/unmanaged-window-operation-behaviour.html b/cli/unmanaged-window-operation-behaviour.html index 283dac27..4e190aaa 100644 --- a/cli/unmanaged-window-operation-behaviour.html +++ b/cli/unmanaged-window-operation-behaviour.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    unmanaged-window-operation-behaviour

    -
    Set the operation behaviour when the focused window is not managed
+
    Set the operation behaviour when the focused window is not managed
 
 Usage: komorebic.exe unmanaged-window-operation-behaviour <OPERATION_BEHAVIOUR>
 
@@ -4047,9 +4069,8 @@ Arguments:
 
 Options:
   -h, --help
-          Print help (see a summary with '-h')
-
-
    
+          Print help (see a summary with '-h')
+
    diff --git a/cli/unstack.html b/cli/unstack.html index 9abf334d..88ef1963 100644 --- a/cli/unstack.html +++ b/cli/unstack.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    unstack

    -
    Unstack the focused window
+
    Unstack the focused window
 
 Usage: komorebic.exe unstack
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/unsubscribe-pipe.html b/cli/unsubscribe-pipe.html index fc218279..badee1b0 100644 --- a/cli/unsubscribe-pipe.html +++ b/cli/unsubscribe-pipe.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    unsubscribe-pipe

    -
    Unsubscribe from komorebi events
+
    Unsubscribe from komorebi events
 
 Usage: komorebic.exe unsubscribe-pipe <NAMED_PIPE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/unsubscribe-socket.html b/cli/unsubscribe-socket.html index d88ed48d..d9ecb7c3 100644 --- a/cli/unsubscribe-socket.html +++ b/cli/unsubscribe-socket.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    unsubscribe-socket

    -
    Unsubscribe from komorebi events
+
    Unsubscribe from komorebi events
 
 Usage: komorebic.exe unsubscribe-socket <SOCKET>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/visible-windows.html b/cli/visible-windows.html index c4604aaa..c9a92cad 100644 --- a/cli/visible-windows.html +++ b/cli/visible-windows.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    visible-windows

    -
    Show a JSON representation of visible windows
+
    Show a JSON representation of visible windows
 
 Usage: komorebic.exe visible-windows
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/watch-configuration.html b/cli/watch-configuration.html index 8c286a8e..0e54174d 100644 --- a/cli/watch-configuration.html +++ b/cli/watch-configuration.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    watch-configuration

    -
    Enable or disable watching of ~/komorebi.ahk (if it exists)
+
    Enable or disable watching of ~/komorebi.ahk (if it exists)
 
 Usage: komorebic.exe watch-configuration <BOOLEAN_STATE>
 
@@ -4046,8 +4068,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/whkdrc.html b/cli/whkdrc.html index 63f7eeaa..6e97dd65 100644 --- a/cli/whkdrc.html +++ b/cli/whkdrc.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,15 +4057,14 @@

    whkdrc

    -
    Show the path to whkdrc
+
    Show the path to whkdrc
 
 Usage: komorebic.exe whkdrc
 
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/window-hiding-behaviour.html b/cli/window-hiding-behaviour.html index 92a8b957..9b32376a 100644 --- a/cli/window-hiding-behaviour.html +++ b/cli/window-hiding-behaviour.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    window-hiding-behaviour

    -
    Set the window behaviour when switching workspaces / cycling stacks
+
    Set the window behaviour when switching workspaces / cycling stacks
 
 Usage: komorebic.exe window-hiding-behaviour <HIDING_BEHAVIOUR>
 
@@ -4048,9 +4070,8 @@ Arguments:
 
 Options:
   -h, --help
-          Print help (see a summary with '-h')
-
-
    
+          Print help (see a summary with '-h')
+
    diff --git a/cli/workspace-custom-layout-rule.html b/cli/workspace-custom-layout-rule.html index 24c00aaa..f8aa17c3 100644 --- a/cli/workspace-custom-layout-rule.html +++ b/cli/workspace-custom-layout-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    workspace-custom-layout-rule

    -
    Add a dynamic custom layout for the specified workspace
+
    Add a dynamic custom layout for the specified workspace
 
 Usage: komorebic.exe workspace-custom-layout-rule <MONITOR> <WORKSPACE> <AT_CONTAINER_COUNT> <PATH>
 
@@ -4055,8 +4077,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/workspace-custom-layout.html b/cli/workspace-custom-layout.html index e3639459..06093621 100644 --- a/cli/workspace-custom-layout.html +++ b/cli/workspace-custom-layout.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    workspace-custom-layout

    -
    Set a custom layout for the specified workspace
+
    Set a custom layout for the specified workspace
 
 Usage: komorebic.exe workspace-custom-layout <MONITOR> <WORKSPACE> <PATH>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/workspace-layout-rule.html b/cli/workspace-layout-rule.html index fa5c45f5..8a0f23c5 100644 --- a/cli/workspace-layout-rule.html +++ b/cli/workspace-layout-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    workspace-layout-rule

    -
    Add a dynamic layout rule for the specified workspace
+
    Add a dynamic layout rule for the specified workspace
 
 Usage: komorebic.exe workspace-layout-rule <MONITOR> <WORKSPACE> <AT_CONTAINER_COUNT> <LAYOUT>
 
@@ -4055,8 +4077,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/workspace-layout.html b/cli/workspace-layout.html index 27583057..973e82d7 100644 --- a/cli/workspace-layout.html +++ b/cli/workspace-layout.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    workspace-layout

    -
    Set the layout for the specified workspace
+
    Set the layout for the specified workspace
 
 Usage: komorebic.exe workspace-layout <MONITOR> <WORKSPACE> <VALUE>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/workspace-name.html b/cli/workspace-name.html index a4cd04a8..949296e9 100644 --- a/cli/workspace-name.html +++ b/cli/workspace-name.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    workspace-name

    -
    Set the workspace name for the specified workspace
+
    Set the workspace name for the specified workspace
 
 Usage: komorebic.exe workspace-name <MONITOR> <WORKSPACE> <VALUE>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/workspace-padding.html b/cli/workspace-padding.html index ec3c0a72..8dacb87e 100644 --- a/cli/workspace-padding.html +++ b/cli/workspace-padding.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    workspace-padding

    -
    Set the workspace padding for the specified workspace
+
    Set the workspace padding for the specified workspace
 
 Usage: komorebic.exe workspace-padding <MONITOR> <WORKSPACE> <SIZE>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/workspace-rule.html b/cli/workspace-rule.html index 4231b4a4..1124aa09 100644 --- a/cli/workspace-rule.html +++ b/cli/workspace-rule.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    workspace-rule

    -
    Add a rule to associate an application with a workspace
+
    Add a rule to associate an application with a workspace
 
 Usage: komorebic.exe workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
 
@@ -4055,8 +4077,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/cli/workspace-tiling.html b/cli/workspace-tiling.html index 22820271..21b42f74 100644 --- a/cli/workspace-tiling.html +++ b/cli/workspace-tiling.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4035,7 +4057,7 @@

    workspace-tiling

    -
    Enable or disable window tiling for the specified workspace
+
    Enable or disable window tiling for the specified workspace
 
 Usage: komorebic.exe workspace-tiling <MONITOR> <WORKSPACE> <VALUE>
 
@@ -4052,8 +4074,7 @@ Arguments:
 Options:
   -h, --help
           Print help
-
-
    
+
    diff --git a/common-workflows/active-window-border.html b/common-workflows/active-window-border.html index d81743ae..fc1c812f 100644 --- a/common-workflows/active-window-border.html +++ b/common-workflows/active-window-border.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4038,29 +4060,28 @@

    If you would like to add a visual border around the currently focused window, ensure the following options are defined in the komorebi.json configuration file.

    -
    {
-  "active_window_border": true,
-  "active_window_border_style": "Rounded",
-  "active_window_border_colours": {
-    "single": {
-      "r": 66,
-      "g": 165,
-      "b": 245
-    },
-    "stack": {
-      "r": 256,
-      "g": 165,
-      "b": 66
-    },
-    "monocle": {
-      "r": 255,
-      "g": 51,
-      "b": 153
-    }
-  },
-}
-
-
    +
    {
+  "active_window_border": true,
+  "active_window_border_style": "Rounded",
+  "active_window_border_colours": {
+    "single": {
+      "r": 66,
+      "g": 165,
+      "b": 245
+    },
+    "stack": {
+      "r": 256,
+      "g": 165,
+      "b": 66
+    },
+    "monocle": {
+      "r": 255,
+      "g": 51,
+      "b": 153
+    }
+  },
+}
+

    It is important to note that the active window border will only apply to windows managed by komorebi.

    This feature is not considered stable, and you may encounter visual artifacts diff --git a/common-workflows/autohotkey.html b/common-workflows/autohotkey.html index 6a0ed9b0..9ce9a113 100644 --- a/common-workflows/autohotkey.html +++ b/common-workflows/autohotkey.html @@ -466,6 +466,8 @@ + +

  • @@ -534,6 +536,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4030,12 +4052,12 @@ does not take into account the use of a static configuration file; if you choose to use a static configuration file alongside AHK, you can remove all the configuration options from your komorebi.ahk and use it solely to handle hotkey bindings.

    -
    # save the latest generated komorebic library to ~/komorebic.lib.ahk
-iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebic.lib.ahk -OutFile $Env:USERPROFILE\komorebic.lib.ahk
+
    # save the latest generated komorebic library to ~/komorebic.lib.ahk
+iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebic.lib.ahk -OutFile $Env:USERPROFILE\komorebic.lib.ahk
 
-# save the sample komorebi configuration file to ~/komorebi.ahk
-iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebi.sample.ahk -OutFile $Env:USERPROFILE\komorebi.ahk
-
    
+# save the sample komorebi configuration file to ~/komorebi.ahk
+iwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebi.sample.ahk -OutFile $Env:USERPROFILE\komorebi.ahk
+
    diff --git a/common-workflows/custom-layouts.html b/common-workflows/custom-layouts.html index 0b60ced3..6c728022 100644 --- a/common-workflows/custom-layouts.html +++ b/common-workflows/custom-layouts.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4045,19 +4067,19 @@ Generator to interactively define a custom layout, and then copy the generated JSON content.

    Custom layouts can be loaded on the current workspace or configured for a specific workspace in the komorebi.json configuration file.

    -
    {
-  "monitors": [
-    {
-      "workspaces": [
-        {
-          "name": "personal",
-          "custom_layout": "C:/Users/LGUG2Z/my-custom-layout.json"
-        },
-      ]
-    }
-  ]
-}
-
    +
    {
+  "monitors": [
+    {
+      "workspaces": [
+        {
+          "name": "personal",
+          "custom_layout": "C:/Users/LGUG2Z/my-custom-layout.json"
+        },
+      ]
+    }
+  ]
+}
+

    The fundamental building block of a custom komorebi layout is the Column.

    Columns come in three variants:

    @@ -4037,33 +4059,33 @@

    Dynamically Layout Switching

    With komorebi it is possible to define rules to automatically change the layout on a specified workspace when a threshold of window containers is met.

    -
    {
-  "monitors": [
-    {
-      "workspaces": [
-        {
-          "name": "personal",
-          "layout_rules": {
-            "1": "BSP"
-          }
-          "custom_layout_rules": {
-            "5": "C:/Users/LGUG2Z/my-custom-layout.json"
-          }
-        },
-      ]
-    }
-  ]
-}
-
    +
    {
+  "monitors": [
+    {
+      "workspaces": [
+        {
+          "name": "personal",
+          "layout_rules": {
+            "1": "BSP"
+          }
+          "custom_layout_rules": {
+            "5": "C:/Users/LGUG2Z/my-custom-layout.json"
+          }
+        },
+      ]
+    }
+  ]
+}
+

    In this example, when there are one or more window containers visible on the screen, the BSP layout is used, and when there are five or more window containers visible, a custom layout is used.

    However, if you add workspace layout rules, you will not be able to manually change the layout of a workspace until all layout rules for that workspace have been cleared.

    -
    # for example, to clear rules from monitor 0, workspace 0
-komorebic clear-workspace-layout-rules 0 0
-
    +
    # for example, to clear rules from monitor 0, workspace 0
+komorebic clear-workspace-layout-rules 0 0
+
    diff --git a/common-workflows/focus-follows-mouse.html b/common-workflows/focus-follows-mouse.html index 365832c8..317b3e43 100644 --- a/common-workflows/focus-follows-mouse.html +++ b/common-workflows/focus-follows-mouse.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4048,16 +4070,16 @@ persists regardless of whether focus-follows-mouse is enabled or disabled at any given time via komorebic's configuration commands.

    If the komorebi process has been started with the --ffm flag, you can enable focus follows mouse behaviour in the komorebi.json configuration file.

    -
    {
-  "focus_follows_mouse": "Komorebi"
-}
-
    +
    {
+  "focus_follows_mouse": "Komorebi"
+}
+

    When calling any of the komorebic commands related to focus-follows-mouse functionality, the windows implementation will be chosen as the default implementation. You can optionally specify the komorebi implementation by passing it as an argument to the --implementation flag:

    -
    komorebic.exe toggle-focus-follows-mouse --implementation komorebi
-
    +
    komorebic.exe toggle-focus-follows-mouse --implementation komorebi
+
    diff --git a/common-workflows/force-manage-windows.html b/common-workflows/force-manage-windows.html index e1343fe9..b89c1a83 100644 --- a/common-workflows/force-manage-windows.html +++ b/common-workflows/force-manage-windows.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4041,16 +4063,16 @@ you

    In some rare cases, a window may not automatically be registered to be managed by komorebi. You can add rules to enforce this behaviour in the komorebi.json configuration file.

    -
    {
-  "manage_rules": [
-    {
-      "kind": "Title",
-      "id": "Media Player",
-      "matching_strategy": "Equals"
-    }
-  ]
-}
-
    +
    {
+  "manage_rules": [
+    {
+      "kind": "Title",
+      "id": "Media Player",
+      "matching_strategy": "Equals"
+    }
+  ]
+}
+
    diff --git a/common-workflows/ignore-windows.html b/common-workflows/ignore-windows.html index e3cdd8e7..59a9a73b 100644 --- a/common-workflows/ignore-windows.html +++ b/common-workflows/ignore-windows.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4041,16 +4063,16 @@ you

    Sometimes you will want a specific application to never be tiled, and instead float all the time. You can add rules to enforce this behaviour in the komorebi.json configuration file.

    -
    {
-  "float_rules": [
-    {
-      "kind": "Title",
-      "id": "Media Player",
-      "matching_strategy": "Equals"
-    }
-  ]
-}
-
    +
    {
+  "float_rules": [
+    {
+      "kind": "Title",
+      "id": "Media Player",
+      "matching_strategy": "Equals"
+    }
+  ]
+}
+
    diff --git a/common-workflows/komorebi-config-home.html b/common-workflows/komorebi-config-home.html index 0a32b295..786c7213 100644 --- a/common-workflows/komorebi-config-home.html +++ b/common-workflows/komorebi-config-home.html @@ -11,7 +11,7 @@ - + @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4039,18 +4061,18 @@ directory, you can specify a custom directory by setting the $Env:KOMOREBI_CONFIG_HOME environment variable.

    For example, to use the ~/.config/komorebi directory:

    -
    # Run this command to make sure that the directory has been created
-mkdir -p ~/.config/komorebi
+
    # Run this command to make sure that the directory has been created
+mkdir -p ~/.config/komorebi
 
-# Run this command to open up your PowerShell profile configuration in Notepad
-notepad $PROFILE
+# Run this command to open up your PowerShell profile configuration in Notepad
+notepad $PROFILE
 
-# Add this line (with your login user!) to the bottom of your PowerShell profile configuration
-$Env:KOMOREBI_CONFIG_HOME = 'C:\Users\LGUG2Z\.config\komorebi'
+# Add this line (with your login user!) to the bottom of your PowerShell profile configuration
+$Env:KOMOREBI_CONFIG_HOME = 'C:\Users\LGUG2Z\.config\komorebi'
 
-# Save the changes and then reload the PowerShell profile
-. $PROFILE
-
    
+# Save the changes and then reload the PowerShell profile
+. $PROFILE
+

    If you already have configuration files that you wish to keep, move them to the ~/.config/komorebi directory.

    The next time you run komorebic start, any files created by or loaded by @@ -4086,7 +4108,7 @@ video" src="https://img.youtube.com/vi/C_KWUqQ6kko/hqdefault.jpg" />

    @@ -4038,10 +4060,10 @@

    By default, the mouse will move to the center of the window when the focus is changed in a given direction. This behaviour is know as 'mouse follows focus'. This behaviour can be disabled in the komorebi.json configuration file.

    -
    {
-  "mouse_follows_focus": false,
-}
-
    +
    {
+  "mouse_follows_focus": false,
+}
+

    Watch the tutorial video

    diff --git a/common-workflows/remove-gaps.html b/common-workflows/remove-gaps.html index 64809f52..1fcebb93 100644 --- a/common-workflows/remove-gaps.html +++ b/common-workflows/remove-gaps.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4039,13 +4061,13 @@ themselves, and between the monitor edges and the windows, you can set the following configuration options to 0 and -1 in the komorebi.json configuration file.

    -
    {
-  "default_workspace_padding": 0,
-  "default_container_padding": 0,
-  "border_width": 0,
-  "border_offset": -1
-}
-
    +
    {
+  "default_workspace_padding": 0,
+  "default_container_padding": 0,
+  "border_width": 0,
+  "border_offset": -1
+}
+

    A restart of komorebi is required after changing these settings.

    Watch the tutorial video

    diff --git a/common-workflows/stackbar.html b/common-workflows/stackbar.html index c58289fa..fc3f2333 100644 --- a/common-workflows/stackbar.html +++ b/common-workflows/stackbar.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4038,19 +4060,19 @@

    If you would like to add a visual stackbar to show which windows are in a container stack ensure the following options are defined in the komorebi.json configuration file.

    -
    {
-  "stackbar": {
-    "height": 40,
-    "mode": "OnStack",
-    "tabs": {
-      "width": 300,
-      "focused_text": "#00a542",
-      "unfocused_text": "#b3b3b3",
-      "background": "#141414"
-    }
-  }
-}
-
    +
    {
+  "stackbar": {
+    "height": 40,
+    "mode": "OnStack",
+    "tabs": {
+      "width": 300,
+      "focused_text": "#00a542",
+      "unfocused_text": "#b3b3b3",
+      "background": "#141414"
+    }
+  }
+}
+

    This feature is not considered stable, and you may encounter visual artifacts from time to time.

    diff --git a/common-workflows/tray-and-multi-window-applications.html b/common-workflows/tray-and-multi-window-applications.html index d8c1f217..89cf9cb8 100644 --- a/common-workflows/tray-and-multi-window-applications.html +++ b/common-workflows/tray-and-multi-window-applications.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4043,16 +4065,16 @@ but minimizing the same window does not, you have probably enabled a 'close/minimize to tray' option for that application. You can tell komorebi to handle this application appropriately by identifying it via the executable name or the window class.

    -
    {
-  "tray_and_multi_window_applications": [
-    {
-      "kind": "Class",
-      "id": "SDL_app",
-      "matching_strategy": "Equals"
-    }
-  ]
-}
-
    +
    {
+  "tray_and_multi_window_applications": [
+    {
+      "kind": "Class",
+      "id": "SDL_app",
+      "matching_strategy": "Equals"
+    }
+  ]
+}
+
    diff --git a/design.html b/design.html index c6d38534..29f8b9cb 100644 --- a/design.html +++ b/design.html @@ -526,6 +526,8 @@ + +
  • @@ -594,6 +596,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4108,9 +4130,9 @@ messages it receives on a dedicated socket.

    whkd) is needed in order to translate keyboard and mouse events to komorebic commands.

    This architecture, popularised by bspwm on Linux and yabai on macOS, is outlined as follows:

    -
              PROCESS                SOCKET
+
              PROCESS                SOCKET
 whkd/ahk  -------->  komorebic  <------>  komorebi
-
    
+

    Data Model

    komorebi holds a list of physical monitors.

    A monitor is just a rectangle of the available work area which contains one or more virtual workspaces.

    diff --git a/example-configurations.html b/example-configurations.html index 88088fae..6a16ecef 100644 --- a/example-configurations.html +++ b/example-configurations.html @@ -14,7 +14,7 @@ - + @@ -474,6 +474,8 @@ + +
  • @@ -722,6 +724,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4366,76 +4388,76 @@ are provided and updated whenever appropriate.

    komorebi and whkd. Pay attention to the output of the command to see where the example files have been downloaded. For most new users this will be in the $Env:USERPROFILE directory.

    -
    komorebic quickstart
-
    +
    komorebic quickstart
+

    With the example configurations downloaded, you can now start komorebi and `whkd.

    -
    komorebic start --whkd
-
    +
    komorebic start --whkd
+

    komorebi.json

    The example window manager configuration sets some sane defaults and provides five preconfigured workspaces on the primary monitor each with a different layout.

    -
    {
-  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.25/schema.json",
-  "app_specific_configuration_path": "$Env:USERPROFILE/applications.yaml",
-  "window_hiding_behaviour": "Cloak",
-  "cross_monitor_move_behaviour": "Insert",
-  "default_workspace_padding": 20,
-  "default_container_padding": 20,
-  "border_width": 8,
-  "border_offset": -1,
-  "active_window_border": false,
-  "active_window_border_colours": {
-    "single": "#42a5f5",
-    "stack": "#00a542",
-    "monocle": "#ff3399"
-  },
-  "stackbar": {
-    "height": 40,
-    "mode": "Never",
-    "tabs": {
-      "width": 300,
-      "focused_text": "#00a542",
-      "unfocused_text": "#b3b3b3",
-      "background": "#141414"
-    }
-  },
-  "monitors": [
-    {
-      "workspaces": [
-        {
-          "name": "I",
-          "layout": "BSP"
-        },
-        {
-          "name": "II",
-          "layout": "VerticalStack"
-        },
-        {
-          "name": "III",
-          "layout": "HorizontalStack"
-        },
-        {
-          "name": "IV",
-          "layout": "UltrawideVerticalStack"
-        },
-        {
-          "name": "V",
-          "layout": "Rows"
-        },
-        {
-          "name": "VI",
-          "layout": "Grid"
-        },
-        {
-          "name": "VII",
-          "layout": "RightMainVerticalStack"
-        }
-      ]
-    }
-  ]
-}
-
    +
    {
+  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.25/schema.json",
+  "app_specific_configuration_path": "$Env:USERPROFILE/applications.yaml",
+  "window_hiding_behaviour": "Cloak",
+  "cross_monitor_move_behaviour": "Insert",
+  "default_workspace_padding": 20,
+  "default_container_padding": 20,
+  "border_width": 8,
+  "border_offset": -1,
+  "active_window_border": false,
+  "active_window_border_colours": {
+    "single": "#42a5f5",
+    "stack": "#00a542",
+    "monocle": "#ff3399"
+  },
+  "stackbar": {
+    "height": 40,
+    "mode": "Never",
+    "tabs": {
+      "width": 300,
+      "focused_text": "#00a542",
+      "unfocused_text": "#b3b3b3",
+      "background": "#141414"
+    }
+  },
+  "monitors": [
+    {
+      "workspaces": [
+        {
+          "name": "I",
+          "layout": "BSP"
+        },
+        {
+          "name": "II",
+          "layout": "VerticalStack"
+        },
+        {
+          "name": "III",
+          "layout": "HorizontalStack"
+        },
+        {
+          "name": "IV",
+          "layout": "UltrawideVerticalStack"
+        },
+        {
+          "name": "V",
+          "layout": "Rows"
+        },
+        {
+          "name": "VI",
+          "layout": "Grid"
+        },
+        {
+          "name": "VII",
+          "layout": "RightMainVerticalStack"
+        }
+      ]
+    }
+  ]
+}
+

    Application-specific configuration

    There is a community-maintained repository @@ -4473,61 +4495,61 @@ windows, or a window that is in monocole mode.

    monocle.

    Layouts

    BSP

    -
    +-------+-----+
+
    +-------+-----+
 |       |     |
 |       +--+--+
 |       |  |--|
 +-------+--+--+
-
    
+

    Vertical Stack

    -
    +-------+-----+
+
    +-------+-----+
 |       |     |
 |       +-----+
 |       |     |
 +-------+-----+
-
    
+

    RightMainVerticalStack

    -
    +-----+-------+
+
    +-----+-------+
 |     |       |
 +-----+       |
 |     |       |
 +-----+-------+
-
    
+

    Horizontal Stack

    -
    +------+------+
+
    +------+------+
 |             |
 |------+------+
 |      |      |
 +------+------+
-
    
+

    Columns

    -
    +--+--+--+--+
+
    +--+--+--+--+
 |  |  |  |  |
 |  |  |  |  |
 |  |  |  |  |
 +--+--+--+--+
-
    
+

    Rows

    If you have a vertical monitor, I recommend using this layout.

    -
    +-----------+
+
    +-----------+
 |-----------|
 |-----------|
 |-----------|
 +-----------+
-
    
+

    Ultrawide Vertical Stack

    If you have an ultrawide monitor, I recommend using this layout.

    -
    +-----+-----------+-----+
+
    +-----+-----------+-----+
 |     |           |     |
 |     |           +-----+
 |     |           |     |
 |     |           +-----+
 |     |           |     |
 +-----+-----------+-----+
-
    
+

    Grid

    If you like the grid layout in LeftWM this is almost exactly the same!

    -
    +-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+
+
    +-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+
 |     |     |   |   |   |   |   |   |   |   |   |   |   |   |
 |     |     |   |   |   |   |   |   |   |   |   |   |   +---+
 +-----+-----+   |   +---+---+   +---+---+---+   +---+---|   |
@@ -4535,7 +4557,7 @@ monocle.
    
 |     |     |   |   |   |   |   |   |   |   |   |   |   |   |
 +-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+
   4 windows       5 windows       6 windows       7 windows
-
    
+

    whkdrc

    whkd is a fairly basic piece of software with a simple configuration format: key bindings go to the left of the colon, and shell commands go to the right of the @@ -4544,7 +4566,7 @@ colon. By default, the whkdrc file should be located in the $ on hotkey bindings that include the Windows key. If this is important to you, I recommend using AutoHotKey to set up your key bindings for komorebic commands instead.

    -
    .shell powershell
+
    .shell powershell
 
 # Reload whkd configuration
 # alt + o                 : taskkill /f /im whkd.exe && start /b whkd # if shell is cmd
@@ -4553,8 +4575,8 @@ alt + shift + o         : komorebic reload-configuration
 
 # App shortcuts - these require shell to be pwsh / powershell
 # The apps will be focused if open, or launched if not open
-# alt + f                 : if ($wshell.AppActivate('Firefox') -eq $False) { start firefox }
-# alt + b                 : if ($wshell.AppActivate('Chrome') -eq $False) { start chrome }
+# alt + f                 : if ($wshell.AppActivate('Firefox') -eq $False) { start firefox }
+# alt + b                 : if ($wshell.AppActivate('Chrome') -eq $False) { start chrome }
 
 # Focus windows
 alt + h                 : komorebic focus left
@@ -4607,7 +4629,7 @@ alt + 3                 : komorebic focus-workspace 2
 alt + shift + 1         : komorebic move-to-workspace 0
 alt + shift + 2         : komorebic move-to-workspace 1
 alt + shift + 3         : komorebic move-to-workspace 2
-
    
+

    Setting .shell

    There is one special directive at the top of the file, .shell which can be set to either powershell, pwsh or cmd. Which one you use will depend on @@ -4681,13 +4703,13 @@ the sample configuration above.

    -
  • + + + + Troubleshooting + + + + +
    • + + + + diff --git a/installation.html b/installation.html index 46d570c2..56671fc2 100644 --- a/installation.html +++ b/installation.html @@ -474,6 +474,8 @@ + +
  • @@ -656,6 +658,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4254,8 +4276,8 @@ it from source if you would pre

    It highly recommended that you enable support for long paths in Windows by running the following command in an Administrator Terminal before installing komorebi.

    -
    Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1
-
    +
    Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1
+

    Scoop

    Make sure you have installed scoop and verified that installed binaries are available in your $PATH before proceeding.

    @@ -4265,11 +4287,11 @@ correctly configured by your package manager and should not be bugs or issues either on the komorebi GitHub repository or Discord server.

    Install komorebi and whkd

    First add the extras bucket

    -
    scoop bucket add extras
-
    +
    scoop bucket add extras
+

    Then install the komorebi and whkd packages using scoop install

    -
    scoop install komorebi whkd
-
    +
    scoop install komorebi whkd
+

    Once komorebi is installed, proceed to get the example configurations.

    WinGet

    @@ -4283,9 +4305,9 @@ correctly configured by your package manager and should not be bugs or issues either on the komorebi GitHub repository or Discord server.

    Install komorebi and whkd

    Install the komorebi and whkd packages using winget install

    -
    winget install LGUG2Z.komorebi
-winget install LGUG2Z.whkd
-
    +
    winget install LGUG2Z.komorebi
+winget install LGUG2Z.whkd
+

    Once komorebi is installed, proceed to get the example configurations.

    Building from source

    @@ -4293,10 +4315,10 @@ configurations.

    compiler toolchain, and the Visual Studio Visual Studio prerequisites.

    Clone the git repository, enter the directory, and build the following binaries:

    -
    cargo +stable install --path komorebi --locked
-cargo +stable install --path komorebic --locked
-cargo +stable install --path komorebic-no-console --locked
-
    +
    cargo +stable install --path komorebi --locked
+cargo +stable install --path komorebic --locked
+cargo +stable install --path komorebic-no-console --locked
+

    If the binaries have been built and added to your $PATH correctly, you should see some output when running komorebi --help and komorebic --help

    Offline

    diff --git a/release/v0-1-22.html b/release/v0-1-22.html index 35b586a8..d3f90dbf 100644 --- a/release/v0-1-22.html +++ b/release/v0-1-22.html @@ -472,6 +472,8 @@ + +
  • @@ -540,6 +542,26 @@ + + + + + +
  • + + + + + Troubleshooting + + + + +
    • + + + + @@ -4158,12 +4180,12 @@ borders for applications that overflow them. If you use the active window border you may end up with a huge border due to these changes.

    active_window_border_width and active_window_border_offset have been renamed to border_width and border_offset as they now also apply outside the context of the active window border.

    -
    {
-  "active_window_border": true,
-  "border_width": 8,
-  "border_offset": -1
-}
-
    +
    {
+  "active_window_border": true,
+  "border_width": 8,
+  "border_offset": -1
+}
+

    Users of the active window border should start from these settings and read the notes below before making further adjustments.

    Changes to active_window_border, and window sizing:

    @@ -4177,23 +4199,23 @@ adjustments.

    Gapless

    • Disable "transparency effects" Personalization > Colors
      • -
    • Set the following settings in komorebi.json:
      • +
    • Set the following settings in komorebi.json: +
      {
+  "default_workspace_padding": 0,
+  "default_container_padding": 0,
+  "border_offset": -1,
+  "border_width": 0
+}
+
    -
    {
-  "default_workspace_padding": 0,
-  "default_container_padding": 0,
-  "border_offset": -1,
-  "border_width": 0
-}
-

    1px border

    A 1px border is drawn around the window edge. Users may see a gap for a single pixel, if the system theme has a transparent edge - this is the windows themed edge, and is not present for all applications.

    -
      {
-  "border_offset": 0,
-  "border_width": 1
-}
-
    +
      {
+  "border_offset": 0,
+  "border_width": 1
+}
+
    diff --git a/search/search_index.json b/search/search_index.json index 9d031d6d..c83425be 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"index.html","title":"Index","text":"

    komorebi is a tiling window manager that works as an extension to Microsoft's Desktop Window Manager in Windows 10 and above.

    komorebi allows you to control application windows, virtual workspaces and display monitors with a CLI which can be used with third-party software such as AutoHotKey to set user-defined keyboard shortcuts.

    komorebi aims to make as few modifications as possible to the operating system and desktop environment by default. Users are free to make such modifications in their own configuration files for komorebi, but these will always remain opt-in and off-by-default.

    There is a Discord server available for komorebi-related discussion, help, troubleshooting etc. If you have any specific feature requests or bugs to report, please create an issue on GitHub.

    There is also a YouTube channel where I share komorebi live programming videos and tutorial videos.

    "},{"location":"design.html","title":"Design","text":""},{"location":"design.html#description","title":"Description","text":"

    komorebi only responds to WinEvents and the messages it receives on a dedicated socket.

    komorebic is a CLI that writes messages on komorebi's socket.

    komorebi doesn't handle any keyboard or mouse inputs; a third party program (e.g. whkd) is needed in order to translate keyboard and mouse events to komorebic commands.

    This architecture, popularised by bspwm on Linux and yabai on macOS, is outlined as follows:

              PROCESS                SOCKET\nwhkd/ahk  -------->  komorebic  <------>  komorebi\n
    "},{"location":"design.html#data-model","title":"Data Model","text":"

    komorebi holds a list of physical monitors.

    A monitor is just a rectangle of the available work area which contains one or more virtual workspaces.

    A workspace holds a list of containers.

    A container is just a rectangle where one or more application windows can be displayed.

    This means that:

    • Every monitor has its own collection of virtual workspaces
    • Workspaces only know about containers and their dimensions, not about individual application windows
    • Every application window must belong to a container, even if that container only contains one application window
    • Many application windows can be stacked and cycled through in the same container within a workspace
    "},{"location":"example-configurations.html","title":"Example configurations","text":"

    komorebi, and tiling window managers in general, are very complex pieces of software.

    In an attempt to reduce some of the initial configuration burden for users who are looking to try out the software for the first time, example configurations are provided and updated whenever appropriate.

    "},{"location":"example-configurations.html#downloading-example-configurations","title":"Downloading example configurations","text":"

    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. For most new users this will be in the $Env:USERPROFILE directory.

    komorebic quickstart\n

    With the example configurations downloaded, you can now start komorebi and `whkd.

    komorebic start --whkd\n
    "},{"location":"example-configurations.html#komorebijson","title":"komorebi.json","text":"

    The example window manager configuration sets some sane defaults and provides five preconfigured workspaces on the primary monitor each with a different layout.

    {\n  \"$schema\": \"https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.25/schema.json\",\n  \"app_specific_configuration_path\": \"$Env:USERPROFILE/applications.yaml\",\n  \"window_hiding_behaviour\": \"Cloak\",\n  \"cross_monitor_move_behaviour\": \"Insert\",\n  \"default_workspace_padding\": 20,\n  \"default_container_padding\": 20,\n  \"border_width\": 8,\n  \"border_offset\": -1,\n  \"active_window_border\": false,\n  \"active_window_border_colours\": {\n    \"single\": \"#42a5f5\",\n    \"stack\": \"#00a542\",\n    \"monocle\": \"#ff3399\"\n  },\n  \"stackbar\": {\n    \"height\": 40,\n    \"mode\": \"Never\",\n    \"tabs\": {\n      \"width\": 300,\n      \"focused_text\": \"#00a542\",\n      \"unfocused_text\": \"#b3b3b3\",\n      \"background\": \"#141414\"\n    }\n  },\n  \"monitors\": [\n    {\n      \"workspaces\": [\n        {\n          \"name\": \"I\",\n          \"layout\": \"BSP\"\n        },\n        {\n          \"name\": \"II\",\n          \"layout\": \"VerticalStack\"\n        },\n        {\n          \"name\": \"III\",\n          \"layout\": \"HorizontalStack\"\n        },\n        {\n          \"name\": \"IV\",\n          \"layout\": \"UltrawideVerticalStack\"\n        },\n        {\n          \"name\": \"V\",\n          \"layout\": \"Rows\"\n        },\n        {\n          \"name\": \"VI\",\n          \"layout\": \"Grid\"\n        },\n        {\n          \"name\": \"VII\",\n          \"layout\": \"RightMainVerticalStack\"\n        }\n      ]\n    }\n  ]\n}\n
    "},{"location":"example-configurations.html#application-specific-configuration","title":"Application-specific configuration","text":"

    There is a community-maintained repository of \"apps behaving badly\" that do not conform to Windows application development guidelines and behave erratically when used with komorebi without additional configuration.

    You can always download the latest version of these configurations by running komorebic fetch-asc. The output of this command will also provide a line that you can paste into komorebi.json to ensure that the window manager looks for the file in the correction location.

    When installing and running komorebi for the first time, the komorebic quickstart command will usually download this file to the $Env:USERPROFILE directory.

    "},{"location":"example-configurations.html#padding","title":"Padding","text":"

    While you can set the workspace padding (the space between the outer edges of the windows and the bezel of your monitor) and the container padding (the space between each of the tiled windows) for each workspace independently, you can also set a default for both of these values that will apply to all workspaces using default_workspace_padding and default_container_padding.

    "},{"location":"example-configurations.html#active-window-border","title":"Active window border","text":"

    You may have seen videos and screenshots of people using komorebi with a thick, colourful active window border. You can also enable this by setting active_window_border to true. However, please be warned that this feature is a crude hack trying to compensate for the insistence of Microsoft Windows design teams to make custom borders with widths that are actually visible to the user a thing of the past and removing this capability from the Win32 API.

    I know it's buggy, and I know that most of the it sucks, but this is something you should be bring up with the billion dollar company and not with me, the solo developer.

    "},{"location":"example-configurations.html#border-colours","title":"Border colours","text":"

    If you choose to use the active window border, you can set different colours to give you visual queues when you are focused on a single window, a stack of windows, or a window that is in monocole mode.

    The example colours given are blue single, green for stack and pink for monocle.

    "},{"location":"example-configurations.html#layouts","title":"Layouts","text":""},{"location":"example-configurations.html#bsp","title":"BSP","text":"
    +-------+-----+\n|       |     |\n|       +--+--+\n|       |  |--|\n+-------+--+--+\n
    "},{"location":"example-configurations.html#vertical-stack","title":"Vertical Stack","text":"
    +-------+-----+\n|       |     |\n|       +-----+\n|       |     |\n+-------+-----+\n
    "},{"location":"example-configurations.html#rightmainverticalstack","title":"RightMainVerticalStack","text":"
    +-----+-------+\n|     |       |\n+-----+       |\n|     |       |\n+-----+-------+\n
    "},{"location":"example-configurations.html#horizontal-stack","title":"Horizontal Stack","text":"
    +------+------+\n|             |\n|------+------+\n|      |      |\n+------+------+\n
    "},{"location":"example-configurations.html#columns","title":"Columns","text":"
    +--+--+--+--+\n|  |  |  |  |\n|  |  |  |  |\n|  |  |  |  |\n+--+--+--+--+\n
    "},{"location":"example-configurations.html#rows","title":"Rows","text":"

    If you have a vertical monitor, I recommend using this layout.

    +-----------+\n|-----------|\n|-----------|\n|-----------|\n+-----------+\n
    "},{"location":"example-configurations.html#ultrawide-vertical-stack","title":"Ultrawide Vertical Stack","text":"

    If you have an ultrawide monitor, I recommend using this layout.

    +-----+-----------+-----+\n|     |           |     |\n|     |           +-----+\n|     |           |     |\n|     |           +-----+\n|     |           |     |\n+-----+-----------+-----+\n
    "},{"location":"example-configurations.html#grid","title":"Grid","text":"

    If you like the grid layout in LeftWM this is almost exactly the same!

    +-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+\n|     |     |   |   |   |   |   |   |   |   |   |   |   |   |\n|     |     |   |   |   |   |   |   |   |   |   |   |   +---+\n+-----+-----+   |   +---+---+   +---+---+---+   +---+---|   |\n|     |     |   |   |   |   |   |   |   |   |   |   |   +---+\n|     |     |   |   |   |   |   |   |   |   |   |   |   |   |\n+-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+\n  4 windows       5 windows       6 windows       7 windows\n
    "},{"location":"example-configurations.html#whkdrc","title":"whkdrc","text":"

    whkd is a fairly basic piece of software with a simple configuration format: key bindings go to the left of the colon, and shell commands go to the right of the colon. By default, the whkdrc file should be located in the $Env:USERPROFILE/.config/ directory.

    Please remember that whkd does not support overriding Microsoft's limitations on hotkey bindings that include the Windows key. If this is important to you, I recommend using AutoHotKey to set up your key bindings for komorebic commands instead.

    .shell powershell\n\n# Reload whkd configuration\n# alt + o                 : taskkill /f /im whkd.exe && start /b whkd # if shell is cmd\nalt + o                 : taskkill /f /im whkd.exe; Start-Process whkd -WindowStyle hidden # if shell is pwsh / powershell\nalt + shift + o         : komorebic reload-configuration\n\n# App shortcuts - these require shell to be pwsh / powershell\n# The apps will be focused if open, or launched if not open\n# alt + f                 : if ($wshell.AppActivate('Firefox') -eq $False) { start firefox }\n# alt + b                 : if ($wshell.AppActivate('Chrome') -eq $False) { start chrome }\n\n# Focus windows\nalt + h                 : komorebic focus left\nalt + j                 : komorebic focus down\nalt + k                 : komorebic focus up\nalt + l                 : komorebic focus right\nalt + shift + oem_4     : komorebic cycle-focus previous # oem_4 is [\nalt + shift + oem_6     : komorebic cycle-focus next # oem_6 is ]\n\n# Move windows\nalt + shift + h         : komorebic move left\nalt + shift + j         : komorebic move down\nalt + shift + k         : komorebic move up\nalt + shift + l         : komorebic move right\nalt + shift + return    : komorebic promote\n\n# Stack windows\nalt + left              : komorebic stack left\nalt + down              : komorebic stack down\nalt + up                : komorebic stack up\nalt + right             : komorebic stack right\nalt + oem_1             : komorebic unstack # oem_1 is ;\nalt + oem_4             : komorebic cycle-stack previous # oem_4 is [\nalt + oem_6             : komorebic cycle-stack next # oem_6 is ]\n\n# Resize\nalt + oem_plus          : komorebic resize-axis horizontal increase\nalt + oem_minus         : komorebic resize-axis horizontal decrease\nalt + shift + oem_plus  : komorebic resize-axis vertical increase\nalt + shift + oem_minus : komorebic resize-axis vertical decrease\n\n# Manipulate windows\nalt + t                 : komorebic toggle-float\nalt + shift + f         : komorebic toggle-monocle\n\n# Window manager options\nalt + shift + r         : komorebic retile\nalt + p                 : komorebic toggle-pause\n\n# Layouts\nalt + x                 : komorebic flip-layout horizontal\nalt + y                 : komorebic flip-layout vertical\n\n# Workspaces\nalt + 1                 : komorebic focus-workspace 0\nalt + 2                 : komorebic focus-workspace 1\nalt + 3                 : komorebic focus-workspace 2\n\n# Move windows across workspaces\nalt + shift + 1         : komorebic move-to-workspace 0\nalt + shift + 2         : komorebic move-to-workspace 1\nalt + shift + 3         : komorebic move-to-workspace 2\n
    "},{"location":"example-configurations.html#setting-shell","title":"Setting .shell","text":"

    There is one special directive at the top of the file, .shell which can be set to either powershell, pwsh or cmd. Which one you use will depend on which shell you use in your terminal.

    • powershell - set this if you are using the version of PowerShell that comes installed with Windows 10+ (the executable file for this is powershell.exe)

    • pwsh - set this if you are using PowerShell 7+, which you have installed yourself either through the Windows Store or WinGet (the executable file for this is pwsh.exe)

    • cmd - set this if you don't want to use PowerShell at all and instead you want to call commands through the shell used by the old-school Command Prompt (the executable file for this is cmd.exe)

    "},{"location":"example-configurations.html#key-codes","title":"Key codes","text":"

    Key codes for alphanumeric and arrow keys are just what you would expect. For punctuation and other keys, please refer to the Virtual Key Codes reference.

    If you want to use one of those key codes, put them into lower case and remove the VK_ prefix. For example, the keycode VK_OEM_PLUS becomes oem_plus in the sample configuration above.

    "},{"location":"installation.html","title":"Getting started","text":"

    komorebi is a tiling window manager for Windows that is comprised comprised of two main binaries, komorebi.exe, which contains the window manager itself, and komorebic.exe, which is the main way to send commands to the tiling window manager.

    It is important to note that neither komorebi.exe or komorebic.exe handle key bindings, because komorebi is a tiling window manager and not a hotkey daemon.

    This getting started guide suggests the installation of whkd to allow you to bind komorebic.exe commands to hotkeys to allow you to communicate with the tiling window manager using keyboard shortcuts.

    However, whkd is a very simple hotkey daemon, and notably, does not include workarounds for Microsoft's restrictions on hotkey combinations that can use the Windows key.

    If using hotkey combinations with the Windows key is important to you, I suggest that once you are familiar with the main komorebic.exe commands used to manipulate the window manager, you use AutoHotKey to handle your key bindings.

    "},{"location":"installation.html#installation","title":"Installation","text":"

    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
    • Building from source
    • Offline
    "},{"location":"installation.html#long-path-support","title":"Long path support","text":"

    It highly recommended that you enable support for long paths in Windows by running the following command in an Administrator Terminal before installing komorebi.

    Set-ItemProperty 'HKLM:\\SYSTEM\\CurrentControlSet\\Control\\FileSystem' -Name 'LongPathsEnabled' -Value 1\n
    "},{"location":"installation.html#scoop","title":"Scoop","text":"

    Make sure you have installed scoop and verified that installed binaries are available in your $PATH before proceeding.

    Issues with komorebi and related commands not being recognized in the terminal ultimately come down to the $PATH environment variable not being correctly configured by your package manager and should not be raised as bugs or issues either on the komorebi GitHub repository or Discord server.

    "},{"location":"installation.html#install-komorebi-and-whkd","title":"Install komorebi and whkd","text":"

    First add the extras bucket

    scoop bucket add extras\n

    Then install the komorebi and whkd packages using scoop install

    scoop install komorebi whkd\n

    Once komorebi is installed, proceed to get the example configurations.

    "},{"location":"installation.html#winget","title":"WinGet","text":"

    Make sure you have installed the latest version of winget and verified that installed binaries are available in your $PATH before proceeding.

    Issues with komorebi and related commands not being recognized in the terminal ultimately come down to the $PATH environment variable not being correctly configured by your package manager and should not be raised as bugs or issues either on the komorebi GitHub repository or Discord server.

    "},{"location":"installation.html#install-komorebi-and-whkd_1","title":"Install komorebi and whkd","text":"

    Install the komorebi and whkd packages using winget install

    winget install LGUG2Z.komorebi\nwinget install LGUG2Z.whkd\n

    Once komorebi is installed, proceed to get the example configurations.

    "},{"location":"installation.html#building-from-source","title":"Building from source","text":"

    Make sure you have installed rustup, a stable rust compiler toolchain, and the Visual Studio Visual Studio prerequisites.

    Clone the git repository, enter the directory, and build the following binaries:

    cargo +stable install --path komorebi --locked\ncargo +stable install --path komorebic --locked\ncargo +stable install --path komorebic-no-console --locked\n

    If the binaries have been built and added to your $PATH correctly, you should see some output when running komorebi --help and komorebic --help

    "},{"location":"installation.html#offline","title":"Offline","text":"

    Download the latest komorebi and whkd MSI installers on an internet-connected computer, then copy them to an offline machine to install.

    Once installed, proceed to get the example configurations (none of the commands for first-time set up and running komorebi require an internet connection).

    "},{"location":"cli/active-window-border-colour.html","title":"active-window-border-colour","text":"
    Set the colour for the active window border\n\nUsage: komorebic.exe active-window-border-colour [OPTIONS] <R> <G> <B>\n\nArguments:\n  <R>\n          Red\n\n  <G>\n          Green\n\n  <B>\n          Blue\n\nOptions:\n  -w, --window-kind <WINDOW_KIND>\n          [default: single]\n          [possible values: single, stack, monocle]\n\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/active-window-border-offset.html","title":"active-window-border-offset","text":"
    Set the offset for the active window border\n\nUsage: komorebic.exe active-window-border-offset <OFFSET>\n\nArguments:\n  <OFFSET>\n          Desired offset of the active window border\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/active-window-border-width.html","title":"active-window-border-width","text":"
    Set the width for the active window border\n\nUsage: komorebic.exe active-window-border-width <WIDTH>\n\nArguments:\n  <WIDTH>\n          Desired width of the active window border\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/active-window-border.html","title":"active-window-border","text":"
    Enable or disable the active window border\n\nUsage: komorebic.exe active-window-border <BOOLEAN_STATE>\n\nArguments:\n  <BOOLEAN_STATE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/adjust-container-padding.html","title":"adjust-container-padding","text":"
    Adjust container padding on the focused workspace\n\nUsage: komorebic.exe adjust-container-padding <SIZING> <ADJUSTMENT>\n\nArguments:\n  <SIZING>\n          [possible values: increase, decrease]\n\n  <ADJUSTMENT>\n          Pixels to adjust by as an integer\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/adjust-workspace-padding.html","title":"adjust-workspace-padding","text":"
    Adjust workspace padding on the focused workspace\n\nUsage: komorebic.exe adjust-workspace-padding <SIZING> <ADJUSTMENT>\n\nArguments:\n  <SIZING>\n          [possible values: increase, decrease]\n\n  <ADJUSTMENT>\n          Pixels to adjust by as an integer\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/ahk-app-specific-configuration.html","title":"ahk-app-specific-configuration","text":"
    Generate common app-specific configurations and fixes to use in komorebi.ahk\n\nUsage: komorebic.exe ahk-app-specific-configuration <PATH> [OVERRIDE_PATH]\n\nArguments:\n  <PATH>\n          YAML file from which the application-specific configurations should be loaded\n\n  [OVERRIDE_PATH]\n          Optional YAML file of overrides to apply over the first file\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/ahk-library.html","title":"ahk-library","text":"
    Generate a library of AutoHotKey helper functions\n\nUsage: komorebic.exe ahk-library\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/application-specific-configuration-schema.html","title":"application-specific-configuration-schema","text":"
    Generate a JSON Schema for applications.yaml\n\nUsage: komorebic.exe application-specific-configuration-schema\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/change-layout.html","title":"change-layout","text":"
    Set the layout on the focused workspace\n\nUsage: komorebic.exe change-layout <DEFAULT_LAYOUT>\n\nArguments:\n  <DEFAULT_LAYOUT>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/check.html","title":"check","text":"
    Check komorebi configuration and related files for common errors\n\nUsage: komorebic.exe check\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/clear-named-workspace-layout-rules.html","title":"clear-named-workspace-layout-rules","text":"
    Clear all dynamic layout rules for the specified workspace\n\nUsage: komorebic.exe clear-named-workspace-layout-rules <WORKSPACE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/clear-workspace-layout-rules.html","title":"clear-workspace-layout-rules","text":"
    Clear all dynamic layout rules for the specified workspace\n\nUsage: komorebic.exe clear-workspace-layout-rules <MONITOR> <WORKSPACE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/close.html","title":"close","text":"
    Close the focused window\n\nUsage: komorebic.exe close\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/complete-configuration.html","title":"complete-configuration","text":"
    Signal that the final configuration option has been sent\n\nUsage: komorebic.exe complete-configuration\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/configuration.html","title":"configuration","text":"
    Show the path to komorebi.json\n\nUsage: komorebic.exe configuration\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/container-padding.html","title":"container-padding","text":"
    Set the container padding for the specified workspace\n\nUsage: komorebic.exe container-padding <MONITOR> <WORKSPACE> <SIZE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <SIZE>\n          Pixels to pad with as an integer\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cross-monitor-move-behaviour.html","title":"cross-monitor-move-behaviour","text":"
    Set the behaviour when moving windows across monitor boundaries\n\nUsage: komorebic.exe cross-monitor-move-behaviour <MOVE_BEHAVIOUR>\n\nArguments:\n  <MOVE_BEHAVIOUR>\n          Possible values:\n          - swap:   Swap the window container with the window container at the edge of the adjacent monitor\n          - insert: Insert the window container into the focused workspace on the adjacent monitor\n\nOptions:\n  -h, --help\n          Print help (see a summary with '-h')\n\n
    "},{"location":"cli/cycle-focus.html","title":"cycle-focus","text":"
    Change focus to the window in the specified cycle direction\n\nUsage: komorebic.exe cycle-focus <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cycle-layout.html","title":"cycle-layout","text":"
    Cycle between available layouts\n\nUsage: komorebic.exe cycle-layout <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cycle-monitor.html","title":"cycle-monitor","text":"
    Focus the monitor in the given cycle direction\n\nUsage: komorebic.exe cycle-monitor <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cycle-move-to-monitor.html","title":"cycle-move-to-monitor","text":"
    Move the focused window to the monitor in the given cycle direction\n\nUsage: komorebic.exe cycle-move-to-monitor <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cycle-move-to-workspace.html","title":"cycle-move-to-workspace","text":"
    Move the focused window to the workspace in the given cycle direction\n\nUsage: komorebic.exe cycle-move-to-workspace <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cycle-move.html","title":"cycle-move","text":"
    Move the focused window in the specified cycle direction\n\nUsage: komorebic.exe cycle-move <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cycle-send-to-monitor.html","title":"cycle-send-to-monitor","text":"
    Send the focused window to the monitor in the given cycle direction\n\nUsage: komorebic.exe cycle-send-to-monitor <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cycle-send-to-workspace.html","title":"cycle-send-to-workspace","text":"
    Send the focused window to the workspace in the given cycle direction\n\nUsage: komorebic.exe cycle-send-to-workspace <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cycle-stack.html","title":"cycle-stack","text":"
    Cycle the focused stack in the specified cycle direction\n\nUsage: komorebic.exe cycle-stack <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/cycle-workspace.html","title":"cycle-workspace","text":"
    Focus the workspace in the given cycle direction\n\nUsage: komorebic.exe cycle-workspace <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/disable-autostart.html","title":"disable-autostart","text":"
    Deletes the komorebi.lnk shortcut in shell:startup to disable autostart\n\nUsage: komorebic.exe disable-autostart\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/display-index-preference.html","title":"display-index-preference","text":"
    Set the display index preference for a monitor identified using its display name\n\nUsage: komorebic.exe display-index-preference <INDEX_PREFERENCE> <DISPLAY>\n\nArguments:\n  <INDEX_PREFERENCE>\n          Preferred monitor index (zero-indexed)\n\n  <DISPLAY>\n          Display name as identified in komorebic state\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/enable-autostart.html","title":"enable-autostart","text":"
    Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi\n\nUsage: komorebic.exe enable-autostart [OPTIONS]\n\nOptions:\n  -c, --config <CONFIG>\n          Path to a static configuration JSON file\n\n  -f, --ffm\n          Enable komorebi's custom focus-follows-mouse implementation\n\n      --whkd\n          Enable autostart of whkd\n\n      --ahk\n          Enable autostart of ahk\n\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/ensure-named-workspaces.html","title":"ensure-named-workspaces","text":"
    Create these many named workspaces for the specified monitor\n\nUsage: komorebic.exe ensure-named-workspaces <MONITOR> [NAMES]...\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  [NAMES]...\n          Names of desired workspaces\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/ensure-workspaces.html","title":"ensure-workspaces","text":"
    Create at least this many workspaces for the specified monitor\n\nUsage: komorebic.exe ensure-workspaces <MONITOR> <WORKSPACE_COUNT>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE_COUNT>\n          Number of desired workspaces\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/fetch-app-specific-configuration.html","title":"fetch-app-specific-configuration","text":"
    Fetch the latest version of applications.yaml from komorebi-application-specific-configuration\n\nUsage: komorebic.exe fetch-app-specific-configuration\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/flip-layout.html","title":"flip-layout","text":"
    Flip the layout on the focused workspace (BSP only)\n\nUsage: komorebic.exe flip-layout <AXIS>\n\nArguments:\n  <AXIS>\n          [possible values: horizontal, vertical, horizontal-and-vertical]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/float-rule.html","title":"float-rule","text":"
    Add a rule to always float the specified application\n\nUsage: komorebic.exe float-rule <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/focus-follows-mouse.html","title":"focus-follows-mouse","text":"
    Enable or disable focus follows mouse for the operating system\n\nUsage: komorebic.exe focus-follows-mouse [OPTIONS] <BOOLEAN_STATE>\n\nArguments:\n  <BOOLEAN_STATE>\n          [possible values: enable, disable]\n\nOptions:\n  -i, --implementation <IMPLEMENTATION>\n          [default: windows]\n\n          Possible values:\n          - komorebi: A custom FFM implementation (slightly more CPU-intensive)\n          - windows:  The native (legacy) Windows FFM implementation\n\n  -h, --help\n          Print help (see a summary with '-h')\n\n
    "},{"location":"cli/focus-last-workspace.html","title":"focus-last-workspace","text":"
    Focus the last focused workspace on the focused monitor\n\nUsage: komorebic.exe focus-last-workspace\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/focus-monitor-workspace.html","title":"focus-monitor-workspace","text":"
    Focus the specified workspace on the target monitor\n\nUsage: komorebic.exe focus-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>\n\nArguments:\n  <TARGET_MONITOR>\n          Target monitor index (zero-indexed)\n\n  <TARGET_WORKSPACE>\n          Workspace index on the target monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/focus-monitor.html","title":"focus-monitor","text":"
    Focus the specified monitor\n\nUsage: komorebic.exe focus-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/focus-named-workspace.html","title":"focus-named-workspace","text":"
    Focus the specified workspace\n\nUsage: komorebic.exe focus-named-workspace <WORKSPACE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/focus-workspace.html","title":"focus-workspace","text":"
    Focus the specified workspace on the focused monitor\n\nUsage: komorebic.exe focus-workspace <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/focus-workspaces.html","title":"focus-workspaces","text":"
    Focus the specified workspace on all monitors\n\nUsage: komorebic.exe focus-workspaces <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/focus.html","title":"focus","text":"
    Change focus to the window in the specified direction\n\nUsage: komorebic.exe focus <OPERATION_DIRECTION>\n\nArguments:\n  <OPERATION_DIRECTION>\n          [possible values: left, right, up, down]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/focused-workspace-container-padding.html","title":"focused-workspace-container-padding","text":"
    Set container padding on the focused workspace\n\nUsage: komorebic.exe focused-workspace-container-padding <SIZE>\n\nArguments:\n  <SIZE>\n          Pixels size to set as an integer\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/focused-workspace-padding.html","title":"focused-workspace-padding","text":"
    Set workspace padding on the focused workspace\n\nUsage: komorebic.exe focused-workspace-padding <SIZE>\n\nArguments:\n  <SIZE>\n          Pixels size to set as an integer\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/force-focus.html","title":"force-focus","text":"
    Forcibly focus the window at the cursor with a left mouse click\n\nUsage: komorebic.exe force-focus\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/format-app-specific-configuration.html","title":"format-app-specific-configuration","text":"
    Format a YAML file for use with the 'ahk-app-specific-configuration' command\n\nUsage: komorebic.exe format-app-specific-configuration <PATH>\n\nArguments:\n  <PATH>\n          YAML file from which the application-specific configurations should be loaded\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/generate-static-config.html","title":"generate-static-config","text":"
    Generates a static configuration JSON file based on the current window manager state\n\nUsage: komorebic.exe generate-static-config\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/global-state.html","title":"global-state","text":"
    Show a JSON representation of the current global state\n\nUsage: komorebic.exe global-state\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/global-work-area-offset.html","title":"global-work-area-offset","text":"
    Set offsets to exclude parts of the work area from tiling\n\nUsage: komorebic.exe global-work-area-offset <LEFT> <TOP> <RIGHT> <BOTTOM>\n\nArguments:\n  <LEFT>\n          Size of the left work area offset (set right to left * 2 to maintain right padding)\n\n  <TOP>\n          Size of the top work area offset (set bottom to the same value to maintain bottom padding)\n\n  <RIGHT>\n          Size of the right work area offset\n\n  <BOTTOM>\n          Size of the bottom work area offset\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/identify-layered-application.html","title":"identify-layered-application","text":"
    Identify an application that has WS_EX_LAYERED, but should still be managed\n\nUsage: komorebic.exe identify-layered-application <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/identify-object-name-change-application.html","title":"identify-object-name-change-application","text":"
    Identify an application that sends EVENT_OBJECT_NAMECHANGE on launch\n\nUsage: komorebic.exe identify-object-name-change-application <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/identify-tray-application.html","title":"identify-tray-application","text":"
    Identify an application that closes to the system tray\n\nUsage: komorebic.exe identify-tray-application <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/initial-named-workspace-rule.html","title":"initial-named-workspace-rule","text":"
    Add a rule to associate an application with a named workspace on first show\n\nUsage: komorebic.exe initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\n  <WORKSPACE>\n          Name of a workspace\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/initial-workspace-rule.html","title":"initial-workspace-rule","text":"
    Add a rule to associate an application with a workspace on first show\n\nUsage: komorebic.exe initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/invisible-borders.html","title":"invisible-borders","text":"
    Set the invisible border dimensions around each window\n\nUsage: komorebic.exe invisible-borders <LEFT> <TOP> <RIGHT> <BOTTOM>\n\nArguments:\n  <LEFT>\n          Size of the left invisible border\n\n  <TOP>\n          Size of the top invisible border (usually 0)\n\n  <RIGHT>\n          Size of the right invisible border (usually left * 2)\n\n  <BOTTOM>\n          Size of the bottom invisible border (usually the same as left)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/load-custom-layout.html","title":"load-custom-layout","text":"
    Load a custom layout from file for the focused workspace\n\nUsage: komorebic.exe load-custom-layout <PATH>\n\nArguments:\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/load-resize.html","title":"load-resize","text":"
    Load the resize layout dimensions from a file\n\nUsage: komorebic.exe load-resize <PATH>\n\nArguments:\n  <PATH>\n          File from which the resize layout dimensions should be loaded\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/log.html","title":"log","text":"
    Tail komorebi.exe's process logs (cancel with Ctrl-C)\n\nUsage: komorebic.exe log\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/manage-rule.html","title":"manage-rule","text":"
    Add a rule to always manage the specified application\n\nUsage: komorebic.exe manage-rule <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/manage.html","title":"manage","text":"
    Force komorebi to manage the focused window\n\nUsage: komorebic.exe manage\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/minimize.html","title":"minimize","text":"
    Minimize the focused window\n\nUsage: komorebic.exe minimize\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/monitor-index-preference.html","title":"monitor-index-preference","text":"
    Set the monitor index preference for a monitor identified using its size\n\nUsage: komorebic.exe monitor-index-preference <INDEX_PREFERENCE> <LEFT> <TOP> <RIGHT> <BOTTOM>\n\nArguments:\n  <INDEX_PREFERENCE>\n          Preferred monitor index (zero-indexed)\n\n  <LEFT>\n          Left value of the monitor's size Rect\n\n  <TOP>\n          Top value of the monitor's size Rect\n\n  <RIGHT>\n          Right value of the monitor's size Rect\n\n  <BOTTOM>\n          Bottom value of the monitor's size Rect\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/monitor-work-area-offset.html","title":"monitor-work-area-offset","text":"
    Set offsets for a monitor to exclude parts of the work area from tiling\n\nUsage: komorebic.exe monitor-work-area-offset <MONITOR> <LEFT> <TOP> <RIGHT> <BOTTOM>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <LEFT>\n          Size of the left work area offset (set right to left * 2 to maintain right padding)\n\n  <TOP>\n          Size of the top work area offset (set bottom to the same value to maintain bottom padding)\n\n  <RIGHT>\n          Size of the right work area offset\n\n  <BOTTOM>\n          Size of the bottom work area offset\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/mouse-follows-focus.html","title":"mouse-follows-focus","text":"
    Enable or disable mouse follows focus on all workspaces\n\nUsage: komorebic.exe mouse-follows-focus <BOOLEAN_STATE>\n\nArguments:\n  <BOOLEAN_STATE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/move-to-monitor-workspace.html","title":"move-to-monitor-workspace","text":"
    Move the focused window to the specified monitor workspace\n\nUsage: komorebic.exe move-to-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>\n\nArguments:\n  <TARGET_MONITOR>\n          Target monitor index (zero-indexed)\n\n  <TARGET_WORKSPACE>\n          Workspace index on the target monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/move-to-monitor.html","title":"move-to-monitor","text":"
    Move the focused window to the specified monitor\n\nUsage: komorebic.exe move-to-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/move-to-named-workspace.html","title":"move-to-named-workspace","text":"
    Move the focused window to the specified workspace\n\nUsage: komorebic.exe move-to-named-workspace <WORKSPACE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/move-to-workspace.html","title":"move-to-workspace","text":"
    Move the focused window to the specified workspace\n\nUsage: komorebic.exe move-to-workspace <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/move-workspace-to-monitor.html","title":"move-workspace-to-monitor","text":"
    Move the focused workspace to the specified monitor\n\nUsage: komorebic.exe move-workspace-to-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/move.html","title":"move","text":"
    Move the focused window in the specified direction\n\nUsage: komorebic.exe move <OPERATION_DIRECTION>\n\nArguments:\n  <OPERATION_DIRECTION>\n          [possible values: left, right, up, down]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/named-workspace-container-padding.html","title":"named-workspace-container-padding","text":"
    Set the container padding for the specified workspace\n\nUsage: komorebic.exe named-workspace-container-padding <WORKSPACE> <SIZE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <SIZE>\n          Pixels to pad with as an integer\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/named-workspace-custom-layout-rule.html","title":"named-workspace-custom-layout-rule","text":"
    Add a dynamic custom layout for the specified workspace\n\nUsage: komorebic.exe named-workspace-custom-layout-rule <WORKSPACE> <AT_CONTAINER_COUNT> <PATH>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <AT_CONTAINER_COUNT>\n          The number of window containers on-screen required to trigger this layout rule\n\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/named-workspace-custom-layout.html","title":"named-workspace-custom-layout","text":"
    Set a custom layout for the specified workspace\n\nUsage: komorebic.exe named-workspace-custom-layout <WORKSPACE> <PATH>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/named-workspace-layout-rule.html","title":"named-workspace-layout-rule","text":"
    Add a dynamic layout rule for the specified workspace\n\nUsage: komorebic.exe named-workspace-layout-rule <WORKSPACE> <AT_CONTAINER_COUNT> <LAYOUT>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <AT_CONTAINER_COUNT>\n          The number of window containers on-screen required to trigger this layout rule\n\n  <LAYOUT>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/named-workspace-layout.html","title":"named-workspace-layout","text":"
    Set the layout for the specified workspace\n\nUsage: komorebic.exe named-workspace-layout <WORKSPACE> <VALUE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <VALUE>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/named-workspace-padding.html","title":"named-workspace-padding","text":"
    Set the workspace padding for the specified workspace\n\nUsage: komorebic.exe named-workspace-padding <WORKSPACE> <SIZE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <SIZE>\n          Pixels to pad with as an integer\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/named-workspace-rule.html","title":"named-workspace-rule","text":"
    Add a rule to associate an application with a named workspace\n\nUsage: komorebic.exe named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\n  <WORKSPACE>\n          Name of a workspace\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/named-workspace-tiling.html","title":"named-workspace-tiling","text":"
    Enable or disable window tiling for the specified workspace\n\nUsage: komorebic.exe named-workspace-tiling <WORKSPACE> <VALUE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <VALUE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/new-workspace.html","title":"new-workspace","text":"
    Create and append a new workspace on the focused monitor\n\nUsage: komorebic.exe new-workspace\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/notification-schema.html","title":"notification-schema","text":"
    Generate a JSON Schema of subscription notifications\n\nUsage: komorebic.exe notification-schema\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/promote-focus.html","title":"promote-focus","text":"
    Promote the user focus to the top of the tree\n\nUsage: komorebic.exe promote-focus\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/promote.html","title":"promote","text":"
    Promote the focused window to the top of the tree\n\nUsage: komorebic.exe promote\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/pwsh-app-specific-configuration.html","title":"pwsh-app-specific-configuration","text":"
    Generate common app-specific configurations and fixes in a PowerShell script\n\nUsage: komorebic.exe pwsh-app-specific-configuration <PATH> [OVERRIDE_PATH]\n\nArguments:\n  <PATH>\n          YAML file from which the application-specific configurations should be loaded\n\n  [OVERRIDE_PATH]\n          Optional YAML file of overrides to apply over the first file\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/query.html","title":"query","text":"
    Query the current window manager state\n\nUsage: komorebic.exe query <STATE_QUERY>\n\nArguments:\n  <STATE_QUERY>\n          [possible values: focused-monitor-index, focused-workspace-index, focused-container-index, focused-window-index]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/quick-load-resize.html","title":"quick-load-resize","text":"
    Load the last quicksaved resize layout dimensions\n\nUsage: komorebic.exe quick-load-resize\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/quick-save-resize.html","title":"quick-save-resize","text":"
    Quicksave the current resize layout dimensions\n\nUsage: komorebic.exe quick-save-resize\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/quickstart.html","title":"quickstart","text":"
    Gather example configurations for a new-user quickstart\n\nUsage: komorebic.exe quickstart\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/reload-configuration.html","title":"reload-configuration","text":"
    Reload ~/komorebi.ahk (if it exists)\n\nUsage: komorebic.exe reload-configuration\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/remove-title-bar.html","title":"remove-title-bar","text":"
    Whitelist an application for title bar removal\n\nUsage: komorebic.exe remove-title-bar <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/resize-axis.html","title":"resize-axis","text":"
    Resize the focused window or primary column along the specified axis\n\nUsage: komorebic.exe resize-axis <AXIS> <SIZING>\n\nArguments:\n  <AXIS>\n          [possible values: horizontal, vertical, horizontal-and-vertical]\n\n  <SIZING>\n          [possible values: increase, decrease]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/resize-delta.html","title":"resize-delta","text":"
    Set the resize delta (used by resize-edge and resize-axis)\n\nUsage: komorebic.exe resize-delta <PIXELS>\n\nArguments:\n  <PIXELS>\n          The delta of pixels by which to increase or decrease window dimensions when resizing\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/resize-edge.html","title":"resize-edge","text":"
    Resize the focused window in the specified direction\n\nUsage: komorebic.exe resize-edge <EDGE> <SIZING>\n\nArguments:\n  <EDGE>\n          [possible values: left, right, up, down]\n\n  <SIZING>\n          [possible values: increase, decrease]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/restore-windows.html","title":"restore-windows","text":"
    Restore all hidden windows (debugging command)\n\nUsage: komorebic.exe restore-windows\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/retile.html","title":"retile","text":"
    Force the retiling of all managed windows\n\nUsage: komorebic.exe retile\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/save-resize.html","title":"save-resize","text":"
    Save the current resize layout dimensions to a file\n\nUsage: komorebic.exe save-resize <PATH>\n\nArguments:\n  <PATH>\n          File to which the resize layout dimensions should be saved\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/send-to-monitor-workspace.html","title":"send-to-monitor-workspace","text":"
    Send the focused window to the specified monitor workspace\n\nUsage: komorebic.exe send-to-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>\n\nArguments:\n  <TARGET_MONITOR>\n          Target monitor index (zero-indexed)\n\n  <TARGET_WORKSPACE>\n          Workspace index on the target monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/send-to-monitor.html","title":"send-to-monitor","text":"
    Send the focused window to the specified monitor\n\nUsage: komorebic.exe send-to-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/send-to-named-workspace.html","title":"send-to-named-workspace","text":"
    Send the focused window to the specified workspace\n\nUsage: komorebic.exe send-to-named-workspace <WORKSPACE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/send-to-workspace.html","title":"send-to-workspace","text":"
    Send the focused window to the specified workspace\n\nUsage: komorebic.exe send-to-workspace <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/socket-schema.html","title":"socket-schema","text":"
    Generate a JSON Schema of socket messages\n\nUsage: komorebic.exe socket-schema\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/stack.html","title":"stack","text":"
    Stack the focused window in the specified direction\n\nUsage: komorebic.exe stack <OPERATION_DIRECTION>\n\nArguments:\n  <OPERATION_DIRECTION>\n          [possible values: left, right, up, down]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/start.html","title":"start","text":"
    Start komorebi.exe as a background process\n\nUsage: komorebic.exe start [OPTIONS]\n\nOptions:\n  -f, --ffm\n          Allow the use of komorebi's custom focus-follows-mouse implementation\n\n  -c, --config <CONFIG>\n          Path to a static configuration JSON file\n\n  -a, --await-configuration\n          Wait for 'komorebic complete-configuration' to be sent before processing events\n\n  -t, --tcp-port <TCP_PORT>\n          Start a TCP server on the given port to allow the direct sending of SocketMessages\n\n      --whkd\n          Start whkd in a background process\n\n      --ahk\n          Start autohotkey configuration file\n\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/state.html","title":"state","text":"
    Show a JSON representation of the current window manager state\n\nUsage: komorebic.exe state\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/static-config-schema.html","title":"static-config-schema","text":"
    Generate a JSON Schema of the static configuration file\n\nUsage: komorebic.exe static-config-schema\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/stop.html","title":"stop","text":"
    Stop the komorebi.exe process and restore all hidden windows\n\nUsage: komorebic.exe stop [OPTIONS]\n\nOptions:\n      --whkd\n          Stop whkd if it is running as a background process\n\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/subscribe-pipe.html","title":"subscribe-pipe","text":"
    Subscribe to komorebi events using a Named Pipe\n\nUsage: komorebic.exe subscribe-pipe <NAMED_PIPE>\n\nArguments:\n  <NAMED_PIPE>\n          Name of the pipe to send event notifications to (without \"\\\\.\\pipe\\\" prepended)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/subscribe-socket.html","title":"subscribe-socket","text":"
    Subscribe to komorebi events using a Unix Domain Socket\n\nUsage: komorebic.exe subscribe-socket <SOCKET>\n\nArguments:\n  <SOCKET>\n          Name of the socket to send event notifications to\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/swap-workspaces-with-monitor.html","title":"swap-workspaces-with-monitor","text":"
    Swap focused monitor workspaces with specified monitor\n\nUsage: komorebic.exe swap-workspaces-with-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/toggle-cross-monitor-move-behaviour.html","title":"toggle-cross-monitor-move-behaviour","text":"
    Toggle the behaviour when moving windows across monitor boundaries\n\nUsage: komorebic.exe toggle-cross-monitor-move-behaviour\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/toggle-float.html","title":"toggle-float","text":"
    Toggle floating mode for the focused window\n\nUsage: komorebic.exe toggle-float\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/toggle-focus-follows-mouse.html","title":"toggle-focus-follows-mouse","text":"
    Toggle focus follows mouse for the operating system\n\nUsage: komorebic.exe toggle-focus-follows-mouse [OPTIONS]\n\nOptions:\n  -i, --implementation <IMPLEMENTATION>\n          [default: windows]\n\n          Possible values:\n          - komorebi: A custom FFM implementation (slightly more CPU-intensive)\n          - windows:  The native (legacy) Windows FFM implementation\n\n  -h, --help\n          Print help (see a summary with '-h')\n\n
    "},{"location":"cli/toggle-maximize.html","title":"toggle-maximize","text":"
    Toggle native maximization for the focused window\n\nUsage: komorebic.exe toggle-maximize\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/toggle-monocle.html","title":"toggle-monocle","text":"
    Toggle monocle mode for the focused container\n\nUsage: komorebic.exe toggle-monocle\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/toggle-mouse-follows-focus.html","title":"toggle-mouse-follows-focus","text":"
    Toggle mouse follows focus on all workspaces\n\nUsage: komorebic.exe toggle-mouse-follows-focus\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/toggle-pause.html","title":"toggle-pause","text":"
    Toggle window tiling on the focused workspace\n\nUsage: komorebic.exe toggle-pause\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/toggle-tiling.html","title":"toggle-tiling","text":"
    Toggle window tiling on the focused workspace\n\nUsage: komorebic.exe toggle-tiling\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/toggle-title-bars.html","title":"toggle-title-bars","text":"
    Toggle title bars for whitelisted applications\n\nUsage: komorebic.exe toggle-title-bars\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/toggle-window-container-behaviour.html","title":"toggle-window-container-behaviour","text":"
    Toggle the behaviour for new windows (stacking or dynamic tiling)\n\nUsage: komorebic.exe toggle-window-container-behaviour\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/unmanage.html","title":"unmanage","text":"
    Unmanage a window that was forcibly managed\n\nUsage: komorebic.exe unmanage\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/unmanaged-window-operation-behaviour.html","title":"unmanaged-window-operation-behaviour","text":"
    Set the operation behaviour when the focused window is not managed\n\nUsage: komorebic.exe unmanaged-window-operation-behaviour <OPERATION_BEHAVIOUR>\n\nArguments:\n  <OPERATION_BEHAVIOUR>\n          Possible values:\n          - op:    Process komorebic commands on temporarily unmanaged/floated windows\n          - no-op: Ignore komorebic commands on temporarily unmanaged/floated windows\n\nOptions:\n  -h, --help\n          Print help (see a summary with '-h')\n\n
    "},{"location":"cli/unstack.html","title":"unstack","text":"
    Unstack the focused window\n\nUsage: komorebic.exe unstack\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/unsubscribe-pipe.html","title":"unsubscribe-pipe","text":"
    Unsubscribe from komorebi events\n\nUsage: komorebic.exe unsubscribe-pipe <NAMED_PIPE>\n\nArguments:\n  <NAMED_PIPE>\n          Name of the pipe to stop sending event notifications to (without \"\\\\.\\pipe\\\" prepended)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/unsubscribe-socket.html","title":"unsubscribe-socket","text":"
    Unsubscribe from komorebi events\n\nUsage: komorebic.exe unsubscribe-socket <SOCKET>\n\nArguments:\n  <SOCKET>\n          Name of the socket to stop sending event notifications to\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/visible-windows.html","title":"visible-windows","text":"
    Show a JSON representation of visible windows\n\nUsage: komorebic.exe visible-windows\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/watch-configuration.html","title":"watch-configuration","text":"
    Enable or disable watching of ~/komorebi.ahk (if it exists)\n\nUsage: komorebic.exe watch-configuration <BOOLEAN_STATE>\n\nArguments:\n  <BOOLEAN_STATE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/whkdrc.html","title":"whkdrc","text":"
    Show the path to whkdrc\n\nUsage: komorebic.exe whkdrc\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/window-hiding-behaviour.html","title":"window-hiding-behaviour","text":"
    Set the window behaviour when switching workspaces / cycling stacks\n\nUsage: komorebic.exe window-hiding-behaviour <HIDING_BEHAVIOUR>\n\nArguments:\n  <HIDING_BEHAVIOUR>\n          Possible values:\n          - hide:     Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps)\n          - minimize: Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching)\n          - cloak:    Use the undocumented SetCloak Win32 function to hide windows when switching workspaces (has foregrounding issues)\n\nOptions:\n  -h, --help\n          Print help (see a summary with '-h')\n\n
    "},{"location":"cli/workspace-custom-layout-rule.html","title":"workspace-custom-layout-rule","text":"
    Add a dynamic custom layout for the specified workspace\n\nUsage: komorebic.exe workspace-custom-layout-rule <MONITOR> <WORKSPACE> <AT_CONTAINER_COUNT> <PATH>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <AT_CONTAINER_COUNT>\n          The number of window containers on-screen required to trigger this layout rule\n\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/workspace-custom-layout.html","title":"workspace-custom-layout","text":"
    Set a custom layout for the specified workspace\n\nUsage: komorebic.exe workspace-custom-layout <MONITOR> <WORKSPACE> <PATH>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/workspace-layout-rule.html","title":"workspace-layout-rule","text":"
    Add a dynamic layout rule for the specified workspace\n\nUsage: komorebic.exe workspace-layout-rule <MONITOR> <WORKSPACE> <AT_CONTAINER_COUNT> <LAYOUT>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <AT_CONTAINER_COUNT>\n          The number of window containers on-screen required to trigger this layout rule\n\n  <LAYOUT>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/workspace-layout.html","title":"workspace-layout","text":"
    Set the layout for the specified workspace\n\nUsage: komorebic.exe workspace-layout <MONITOR> <WORKSPACE> <VALUE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <VALUE>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/workspace-name.html","title":"workspace-name","text":"
    Set the workspace name for the specified workspace\n\nUsage: komorebic.exe workspace-name <MONITOR> <WORKSPACE> <VALUE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <VALUE>\n          Name of the workspace as a String\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/workspace-padding.html","title":"workspace-padding","text":"
    Set the workspace padding for the specified workspace\n\nUsage: komorebic.exe workspace-padding <MONITOR> <WORKSPACE> <SIZE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <SIZE>\n          Pixels to pad with as an integer\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/workspace-rule.html","title":"workspace-rule","text":"
    Add a rule to associate an application with a workspace\n\nUsage: komorebic.exe workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"cli/workspace-tiling.html","title":"workspace-tiling","text":"
    Enable or disable window tiling for the specified workspace\n\nUsage: komorebic.exe workspace-tiling <MONITOR> <WORKSPACE> <VALUE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <VALUE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n\n
    "},{"location":"common-workflows/active-window-border.html","title":"Active Window Border","text":"

    If you would like to add a visual border around the currently focused window, ensure the following options are defined in the komorebi.json configuration file.

    {\n  \"active_window_border\": true,\n  \"active_window_border_style\": \"Rounded\",\n  \"active_window_border_colours\": {\n    \"single\": {\n      \"r\": 66,\n      \"g\": 165,\n      \"b\": 245\n    },\n    \"stack\": {\n      \"r\": 256,\n      \"g\": 165,\n      \"b\": 66\n    },\n    \"monocle\": {\n      \"r\": 255,\n      \"g\": 51,\n      \"b\": 153\n    }\n  },\n}\n\n

    It is important to note that the active window border will only apply to windows managed by komorebi.

    This feature is not considered stable, and you may encounter visual artifacts from time to time.

    "},{"location":"common-workflows/autohotkey.html","title":"AutoHotKey","text":"

    If you would like to use Autohotkey, please make sure you have AutoHotKey v2 installed.

    Generally, users who opt for AHK will have specific needs that can only be addressed by the advanced functionality of AHK, and so they are assumed to be able to craft their own configuration files.

    If you would like to try out AHK, a simple sample configuration powered by komorebic.lib.ahk is provided as a starting point. This sample configuration does not take into account the use of a static configuration file; if you choose to use a static configuration file alongside AHK, you can remove all the configuration options from your komorebi.ahk and use it solely to handle hotkey bindings.

    # save the latest generated komorebic library to ~/komorebic.lib.ahk\niwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebic.lib.ahk -OutFile $Env:USERPROFILE\\komorebic.lib.ahk\n\n# save the sample komorebi configuration file to ~/komorebi.ahk\niwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebi.sample.ahk -OutFile $Env:USERPROFILE\\komorebi.ahk\n
    "},{"location":"common-workflows/custom-layouts.html","title":"Custom Layouts","text":"

    Particularly for users of ultrawide monitors, traditional tiling layouts may not seem like the most efficient use of screen space. If you feel this is the case with any of the default layouts, you are also welcome to create your own custom layouts and save them as JSON or YAML.

    If you're not comfortable writing the layouts directly in JSON or YAML, you can use the komorebi Custom Layout Generator to interactively define a custom layout, and then copy the generated JSON content.

    Custom layouts can be loaded on the current workspace or configured for a specific workspace in the komorebi.json configuration file.

    {\n  \"monitors\": [\n    {\n      \"workspaces\": [\n        {\n          \"name\": \"personal\",\n          \"custom_layout\": \"C:/Users/LGUG2Z/my-custom-layout.json\"\n        },\n      ]\n    }\n  ]\n}\n

    The fundamental building block of a custom komorebi layout is the Column.

    Columns come in three variants:

    • Primary: This is where your primary focus will be on the screen most of the time. There must be exactly one Primary Column in any custom layout. Optionally, you can specify the percentage of the screen width that you want the Primary Column to occupy.
    • Secondary: This is an optional column that can either be full height of split horizontally into a fixed number of maximum rows. There can be any number of Secondary Columns in a custom layout.
    • Tertiary: This is the final column where any remaining windows will be split horizontally into rows as they get added.

    If there is only one window on the screen when a custom layout is selected, that window will take up the full work area of the screen.

    If the number of windows is equal to or less than the total number of columns defined in a custom layout, the windows will be arranged in an equal-width columns.

    When the number of windows is greater than the number of columns defined in the custom layout, the windows will begin to be arranged according to the constraints set on the Primary and Secondary columns of the layout.

    Here is an example custom layout that can be used as a starting point for your own:

    - column: Secondary\n  configuration: !Horizontal 2 # max number of rows\n- column: Primary\n  configuration: !WidthPercentage 50 # percentage of screen\n- column: Tertiary\n  configuration: Horizontal\n

    "},{"location":"common-workflows/dynamic-layout-switching.html","title":"Dynamically Layout Switching","text":"

    With komorebi it is possible to define rules to automatically change the layout on a specified workspace when a threshold of window containers is met.

    {\n  \"monitors\": [\n    {\n      \"workspaces\": [\n        {\n          \"name\": \"personal\",\n          \"layout_rules\": {\n            \"1\": \"BSP\"\n          }\n          \"custom_layout_rules\": {\n            \"5\": \"C:/Users/LGUG2Z/my-custom-layout.json\"\n          }\n        },\n      ]\n    }\n  ]\n}\n

    In this example, when there are one or more window containers visible on the screen, the BSP layout is used, and when there are five or more window containers visible, a custom layout is used.

    However, if you add workspace layout rules, you will not be able to manually change the layout of a workspace until all layout rules for that workspace have been cleared.

    # for example, to clear rules from monitor 0, workspace 0\nkomorebic clear-workspace-layout-rules 0 0\n
    "},{"location":"common-workflows/focus-follows-mouse.html","title":"Focus Follows Mouse","text":"

    komorebi supports two focus-follows-mouse implementations; the native Windows Xmouse implementation, which treats the desktop, the task bar, and the system tray as windows and switches focus to them eagerly, and a custom komorebi implementation, which only considers windows managed by komorebi as valid targets to switch focus to when moving the mouse.

    To enable the komorebi implementation you must start the process with the --ffm flag to explicitly enable the feature. This is because the mouse tracking required for this feature significantly increases the CPU usage of the process (on my machine, it jumps from <1% to ~4~), and this CPU increase persists regardless of whether focus-follows-mouse is enabled or disabled at any given time via komorebic's configuration commands.

    If the komorebi process has been started with the --ffm flag, you can enable focus follows mouse behaviour in the komorebi.json configuration file.

    {\n  \"focus_follows_mouse\": \"Komorebi\"\n}\n

    When calling any of the komorebic commands related to focus-follows-mouse functionality, the windows implementation will be chosen as the default implementation. You can optionally specify the komorebi implementation by passing it as an argument to the --implementation flag:

    komorebic.exe toggle-focus-follows-mouse --implementation komorebi\n
    "},{"location":"common-workflows/force-manage-windows.html","title":"Force Manage Windows","text":"

    \u2757\ufe0fNOTE: A significant number of force-manage window rules for the most common applications are already generated for you

    In some rare cases, a window may not automatically be registered to be managed by komorebi. You can add rules to enforce this behaviour in the komorebi.json configuration file.

    {\n  \"manage_rules\": [\n    {\n      \"kind\": \"Title\",\n      \"id\": \"Media Player\",\n      \"matching_strategy\": \"Equals\"\n    }\n  ]\n}\n
    "},{"location":"common-workflows/ignore-windows.html","title":"Ignore Windows","text":"

    \u2757\ufe0fNOTE: A significant number of ignored window rules for the most common applications are already generated for you

    Sometimes you will want a specific application to never be tiled, and instead float all the time. You can add rules to enforce this behaviour in the komorebi.json configuration file.

    {\n  \"float_rules\": [\n    {\n      \"kind\": \"Title\",\n      \"id\": \"Media Player\",\n      \"matching_strategy\": \"Equals\"\n    }\n  ]\n}\n
    "},{"location":"common-workflows/komorebi-config-home.html","title":"KOMOREBI_CONFIG_HOME","text":"

    If you do not want to keep komorebi-related files in your $Env:USERPROFILE directory, you can specify a custom directory by setting the $Env:KOMOREBI_CONFIG_HOME environment variable.

    For example, to use the ~/.config/komorebi directory:

    # Run this command to make sure that the directory has been created\nmkdir -p ~/.config/komorebi\n\n# Run this command to open up your PowerShell profile configuration in Notepad\nnotepad $PROFILE\n\n# Add this line (with your login user!) to the bottom of your PowerShell profile configuration\n$Env:KOMOREBI_CONFIG_HOME = 'C:\\Users\\LGUG2Z\\.config\\komorebi'\n\n# Save the changes and then reload the PowerShell profile\n. $PROFILE\n

    If you already have configuration files that you wish to keep, move them to the ~/.config/komorebi directory.

    The next time you run komorebic start, any files created by or loaded by komorebi will be placed or expected to exist in this folder.

    "},{"location":"common-workflows/mouse-follows-focus.html","title":"Mouse Follows Focus","text":"

    By default, the mouse will move to the center of the window when the focus is changed in a given direction. This behaviour is know as 'mouse follows focus'. This behaviour can be disabled in the komorebi.json configuration file.

    {\n  \"mouse_follows_focus\": false,\n}\n

    "},{"location":"common-workflows/remove-gaps.html","title":"Remove Gaps","text":"

    If you would like to remove all gaps by default, both between windows themselves, and between the monitor edges and the windows, you can set the following configuration options to 0 and -1 in the komorebi.json configuration file.

    {\n  \"default_workspace_padding\": 0,\n  \"default_container_padding\": 0,\n  \"border_width\": 0,\n  \"border_offset\": -1\n}\n

    A restart of komorebi is required after changing these settings.

    "},{"location":"common-workflows/stackbar.html","title":"Stackbar","text":"

    If you would like to add a visual stackbar to show which windows are in a container stack ensure the following options are defined in the komorebi.json configuration file.

    {\n  \"stackbar\": {\n    \"height\": 40,\n    \"mode\": \"OnStack\",\n    \"tabs\": {\n      \"width\": 300,\n      \"focused_text\": \"#00a542\",\n      \"unfocused_text\": \"#b3b3b3\",\n      \"background\": \"#141414\"\n    }\n  }\n}\n

    This feature is not considered stable, and you may encounter visual artifacts from time to time.

    "},{"location":"common-workflows/tray-and-multi-window-applications.html","title":"Tray and Multi-Window Applications","text":"

    \u2757\ufe0fNOTE: A significant number of tray and multi-window application rules for the most common applications are already generated for you

    If you are experiencing behaviour where closing a window leaves a blank tile, but minimizing the same window does not, you have probably enabled a 'close/minimize to tray' option for that application. You can tell komorebi to handle this application appropriately by identifying it via the executable name or the window class.

    {\n  \"tray_and_multi_window_applications\": [\n    {\n      \"kind\": \"Class\",\n      \"id\": \"SDL_app\",\n      \"matching_strategy\": \"Equals\"\n    }\n  ]\n}\n
    "},{"location":"release/v0-1-22.html","title":"V0 1 22","text":"

    In addition to the changelog of new features and fixes, please note the following changes from v0.1.21 to adjust your configuration files accordingly.

    "},{"location":"release/v0-1-22.html#tldr","title":"tl;dr","text":"

    The way windows are sized and drawn has been improved to remove the need to manually specify and remove invisible borders for applications that overflow them. If you use the active window border, the first time you launch v0.1.22 you may end up with a huge border due to these changes.

    active_window_border_width and active_window_border_offset have been renamed to border_width and border_offset as they now also apply outside the context of the active window border.

    {\n  \"active_window_border\": true,\n  \"border_width\": 8,\n  \"border_offset\": -1\n}\n

    Users of the active window border should start from these settings and read the notes below before making further adjustments.

    "},{"location":"release/v0-1-22.html#changes-to-active_window_border-and-window-sizing","title":"Changes to active_window_border, and window sizing:","text":"
    • The border no longer creates a second drop-shadow around the active window
    • Windows are now sized to fill the layout region entirely, ignoring window decorations such as drop shadows
    • Border offset now starts exactly at the paint edge of the window on all sides
    • Windows are sized such that the border offset and border width are taken into account
    "},{"location":"release/v0-1-22.html#recommended-patterns","title":"Recommended patterns","text":""},{"location":"release/v0-1-22.html#gapless","title":"Gapless","text":"
    • Disable \"transparency effects\" Personalization > Colors
    • Set the following settings in komorebi.json:
    {\n  \"default_workspace_padding\": 0,\n  \"default_container_padding\": 0,\n  \"border_offset\": -1,\n  \"border_width\": 0\n}\n
    "},{"location":"release/v0-1-22.html#1px-border","title":"1px border","text":"

    A 1px border is drawn around the window edge. Users may see a gap for a single pixel, if the system theme has a transparent edge - this is the windows themed edge, and is not present for all applications.

      {\n  \"border_offset\": 0,\n  \"border_width\": 1\n}\n
    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"index.html","title":"Index","text":"

    komorebi is a tiling window manager that works as an extension to Microsoft's Desktop Window Manager in Windows 10 and above.

    komorebi allows you to control application windows, virtual workspaces and display monitors with a CLI which can be used with third-party software such as AutoHotKey to set user-defined keyboard shortcuts.

    komorebi aims to make as few modifications as possible to the operating system and desktop environment by default. Users are free to make such modifications in their own configuration files for komorebi, but these will always remain opt-in and off-by-default.

    There is a Discord server available for komorebi-related discussion, help, troubleshooting etc. If you have any specific feature requests or bugs to report, please create an issue on GitHub.

    There is also a YouTube channel where I share komorebi live programming videos and tutorial videos.

    "},{"location":"design.html","title":"Design","text":""},{"location":"design.html#description","title":"Description","text":"

    komorebi only responds to WinEvents and the messages it receives on a dedicated socket.

    komorebic is a CLI that writes messages on komorebi's socket.

    komorebi doesn't handle any keyboard or mouse inputs; a third party program (e.g. whkd) is needed in order to translate keyboard and mouse events to komorebic commands.

    This architecture, popularised by bspwm on Linux and yabai on macOS, is outlined as follows:

              PROCESS                SOCKET\nwhkd/ahk  -------->  komorebic  <------>  komorebi\n
    "},{"location":"design.html#data-model","title":"Data Model","text":"

    komorebi holds a list of physical monitors.

    A monitor is just a rectangle of the available work area which contains one or more virtual workspaces.

    A workspace holds a list of containers.

    A container is just a rectangle where one or more application windows can be displayed.

    This means that:

    • Every monitor has its own collection of virtual workspaces
    • Workspaces only know about containers and their dimensions, not about individual application windows
    • Every application window must belong to a container, even if that container only contains one application window
    • Many application windows can be stacked and cycled through in the same container within a workspace
    "},{"location":"example-configurations.html","title":"Example configurations","text":"

    komorebi, and tiling window managers in general, are very complex pieces of software.

    In an attempt to reduce some of the initial configuration burden for users who are looking to try out the software for the first time, example configurations are provided and updated whenever appropriate.

    "},{"location":"example-configurations.html#downloading-example-configurations","title":"Downloading example configurations","text":"

    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. For most new users this will be in the $Env:USERPROFILE directory.

    komorebic quickstart\n

    With the example configurations downloaded, you can now start komorebi and `whkd.

    komorebic start --whkd\n
    "},{"location":"example-configurations.html#komorebijson","title":"komorebi.json","text":"

    The example window manager configuration sets some sane defaults and provides five preconfigured workspaces on the primary monitor each with a different layout.

    {\n\"$schema\": \"https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.25/schema.json\",\n\"app_specific_configuration_path\": \"$Env:USERPROFILE/applications.yaml\",\n\"window_hiding_behaviour\": \"Cloak\",\n\"cross_monitor_move_behaviour\": \"Insert\",\n\"default_workspace_padding\": 20,\n\"default_container_padding\": 20,\n\"border_width\": 8,\n\"border_offset\": -1,\n\"active_window_border\": false,\n\"active_window_border_colours\": {\n\"single\": \"#42a5f5\",\n\"stack\": \"#00a542\",\n\"monocle\": \"#ff3399\"\n},\n\"stackbar\": {\n\"height\": 40,\n\"mode\": \"Never\",\n\"tabs\": {\n\"width\": 300,\n\"focused_text\": \"#00a542\",\n\"unfocused_text\": \"#b3b3b3\",\n\"background\": \"#141414\"\n}\n},\n\"monitors\": [\n{\n\"workspaces\": [\n{\n\"name\": \"I\",\n\"layout\": \"BSP\"\n},\n{\n\"name\": \"II\",\n\"layout\": \"VerticalStack\"\n},\n{\n\"name\": \"III\",\n\"layout\": \"HorizontalStack\"\n},\n{\n\"name\": \"IV\",\n\"layout\": \"UltrawideVerticalStack\"\n},\n{\n\"name\": \"V\",\n\"layout\": \"Rows\"\n},\n{\n\"name\": \"VI\",\n\"layout\": \"Grid\"\n},\n{\n\"name\": \"VII\",\n\"layout\": \"RightMainVerticalStack\"\n}\n]\n}\n]\n}\n
    "},{"location":"example-configurations.html#application-specific-configuration","title":"Application-specific configuration","text":"

    There is a community-maintained repository of \"apps behaving badly\" that do not conform to Windows application development guidelines and behave erratically when used with komorebi without additional configuration.

    You can always download the latest version of these configurations by running komorebic fetch-asc. The output of this command will also provide a line that you can paste into komorebi.json to ensure that the window manager looks for the file in the correction location.

    When installing and running komorebi for the first time, the komorebic quickstart command will usually download this file to the $Env:USERPROFILE directory.

    "},{"location":"example-configurations.html#padding","title":"Padding","text":"

    While you can set the workspace padding (the space between the outer edges of the windows and the bezel of your monitor) and the container padding (the space between each of the tiled windows) for each workspace independently, you can also set a default for both of these values that will apply to all workspaces using default_workspace_padding and default_container_padding.

    "},{"location":"example-configurations.html#active-window-border","title":"Active window border","text":"

    You may have seen videos and screenshots of people using komorebi with a thick, colourful active window border. You can also enable this by setting active_window_border to true. However, please be warned that this feature is a crude hack trying to compensate for the insistence of Microsoft Windows design teams to make custom borders with widths that are actually visible to the user a thing of the past and removing this capability from the Win32 API.

    I know it's buggy, and I know that most of the it sucks, but this is something you should be bring up with the billion dollar company and not with me, the solo developer.

    "},{"location":"example-configurations.html#border-colours","title":"Border colours","text":"

    If you choose to use the active window border, you can set different colours to give you visual queues when you are focused on a single window, a stack of windows, or a window that is in monocole mode.

    The example colours given are blue single, green for stack and pink for monocle.

    "},{"location":"example-configurations.html#layouts","title":"Layouts","text":""},{"location":"example-configurations.html#bsp","title":"BSP","text":"
    +-------+-----+\n|       |     |\n|       +--+--+\n|       |  |--|\n+-------+--+--+\n
    "},{"location":"example-configurations.html#vertical-stack","title":"Vertical Stack","text":"
    +-------+-----+\n|       |     |\n|       +-----+\n|       |     |\n+-------+-----+\n
    "},{"location":"example-configurations.html#rightmainverticalstack","title":"RightMainVerticalStack","text":"
    +-----+-------+\n|     |       |\n+-----+       |\n|     |       |\n+-----+-------+\n
    "},{"location":"example-configurations.html#horizontal-stack","title":"Horizontal Stack","text":"
    +------+------+\n|             |\n|------+------+\n|      |      |\n+------+------+\n
    "},{"location":"example-configurations.html#columns","title":"Columns","text":"
    +--+--+--+--+\n|  |  |  |  |\n|  |  |  |  |\n|  |  |  |  |\n+--+--+--+--+\n
    "},{"location":"example-configurations.html#rows","title":"Rows","text":"

    If you have a vertical monitor, I recommend using this layout.

    +-----------+\n|-----------|\n|-----------|\n|-----------|\n+-----------+\n
    "},{"location":"example-configurations.html#ultrawide-vertical-stack","title":"Ultrawide Vertical Stack","text":"

    If you have an ultrawide monitor, I recommend using this layout.

    +-----+-----------+-----+\n|     |           |     |\n|     |           +-----+\n|     |           |     |\n|     |           +-----+\n|     |           |     |\n+-----+-----------+-----+\n
    "},{"location":"example-configurations.html#grid","title":"Grid","text":"

    If you like the grid layout in LeftWM this is almost exactly the same!

    +-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+\n|     |     |   |   |   |   |   |   |   |   |   |   |   |   |\n|     |     |   |   |   |   |   |   |   |   |   |   |   +---+\n+-----+-----+   |   +---+---+   +---+---+---+   +---+---|   |\n|     |     |   |   |   |   |   |   |   |   |   |   |   +---+\n|     |     |   |   |   |   |   |   |   |   |   |   |   |   |\n+-----+-----+   +---+---+---+   +---+---+---+   +---+---+---+\n  4 windows       5 windows       6 windows       7 windows\n
    "},{"location":"example-configurations.html#whkdrc","title":"whkdrc","text":"

    whkd is a fairly basic piece of software with a simple configuration format: key bindings go to the left of the colon, and shell commands go to the right of the colon. By default, the whkdrc file should be located in the $Env:USERPROFILE/.config/ directory.

    Please remember that whkd does not support overriding Microsoft's limitations on hotkey bindings that include the Windows key. If this is important to you, I recommend using AutoHotKey to set up your key bindings for komorebic commands instead.

    .shell powershell\n\n# Reload whkd configuration\n# alt + o                 : taskkill /f /im whkd.exe && start /b whkd # if shell is cmd\nalt + o                 : taskkill /f /im whkd.exe; Start-Process whkd -WindowStyle hidden # if shell is pwsh / powershell\nalt + shift + o         : komorebic reload-configuration\n\n# App shortcuts - these require shell to be pwsh / powershell\n# The apps will be focused if open, or launched if not open\n# alt + f                 : if ($wshell.AppActivate('Firefox') -eq $False) { start firefox }\n# alt + b                 : if ($wshell.AppActivate('Chrome') -eq $False) { start chrome }\n\n# Focus windows\nalt + h                 : komorebic focus left\nalt + j                 : komorebic focus down\nalt + k                 : komorebic focus up\nalt + l                 : komorebic focus right\nalt + shift + oem_4     : komorebic cycle-focus previous # oem_4 is [\nalt + shift + oem_6     : komorebic cycle-focus next # oem_6 is ]\n\n# Move windows\nalt + shift + h         : komorebic move left\nalt + shift + j         : komorebic move down\nalt + shift + k         : komorebic move up\nalt + shift + l         : komorebic move right\nalt + shift + return    : komorebic promote\n\n# Stack windows\nalt + left              : komorebic stack left\nalt + down              : komorebic stack down\nalt + up                : komorebic stack up\nalt + right             : komorebic stack right\nalt + oem_1             : komorebic unstack # oem_1 is ;\nalt + oem_4             : komorebic cycle-stack previous # oem_4 is [\nalt + oem_6             : komorebic cycle-stack next # oem_6 is ]\n\n# Resize\nalt + oem_plus          : komorebic resize-axis horizontal increase\nalt + oem_minus         : komorebic resize-axis horizontal decrease\nalt + shift + oem_plus  : komorebic resize-axis vertical increase\nalt + shift + oem_minus : komorebic resize-axis vertical decrease\n\n# Manipulate windows\nalt + t                 : komorebic toggle-float\nalt + shift + f         : komorebic toggle-monocle\n\n# Window manager options\nalt + shift + r         : komorebic retile\nalt + p                 : komorebic toggle-pause\n\n# Layouts\nalt + x                 : komorebic flip-layout horizontal\nalt + y                 : komorebic flip-layout vertical\n\n# Workspaces\nalt + 1                 : komorebic focus-workspace 0\nalt + 2                 : komorebic focus-workspace 1\nalt + 3                 : komorebic focus-workspace 2\n\n# Move windows across workspaces\nalt + shift + 1         : komorebic move-to-workspace 0\nalt + shift + 2         : komorebic move-to-workspace 1\nalt + shift + 3         : komorebic move-to-workspace 2\n
    "},{"location":"example-configurations.html#setting-shell","title":"Setting .shell","text":"

    There is one special directive at the top of the file, .shell which can be set to either powershell, pwsh or cmd. Which one you use will depend on which shell you use in your terminal.

    • powershell - set this if you are using the version of PowerShell that comes installed with Windows 10+ (the executable file for this is powershell.exe)

    • pwsh - set this if you are using PowerShell 7+, which you have installed yourself either through the Windows Store or WinGet (the executable file for this is pwsh.exe)

    • cmd - set this if you don't want to use PowerShell at all and instead you want to call commands through the shell used by the old-school Command Prompt (the executable file for this is cmd.exe)

    "},{"location":"example-configurations.html#key-codes","title":"Key codes","text":"

    Key codes for alphanumeric and arrow keys are just what you would expect. For punctuation and other keys, please refer to the Virtual Key Codes reference.

    If you want to use one of those key codes, put them into lower case and remove the VK_ prefix. For example, the keycode VK_OEM_PLUS becomes oem_plus in the sample configuration above.

    "},{"location":"installation.html","title":"Getting started","text":"

    komorebi is a tiling window manager for Windows that is comprised comprised of two main binaries, komorebi.exe, which contains the window manager itself, and komorebic.exe, which is the main way to send commands to the tiling window manager.

    It is important to note that neither komorebi.exe or komorebic.exe handle key bindings, because komorebi is a tiling window manager and not a hotkey daemon.

    This getting started guide suggests the installation of whkd to allow you to bind komorebic.exe commands to hotkeys to allow you to communicate with the tiling window manager using keyboard shortcuts.

    However, whkd is a very simple hotkey daemon, and notably, does not include workarounds for Microsoft's restrictions on hotkey combinations that can use the Windows key.

    If using hotkey combinations with the Windows key is important to you, I suggest that once you are familiar with the main komorebic.exe commands used to manipulate the window manager, you use AutoHotKey to handle your key bindings.

    "},{"location":"installation.html#installation","title":"Installation","text":"

    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
    • Building from source
    • Offline
    "},{"location":"installation.html#long-path-support","title":"Long path support","text":"

    It highly recommended that you enable support for long paths in Windows by running the following command in an Administrator Terminal before installing komorebi.

    Set-ItemProperty 'HKLM:\\SYSTEM\\CurrentControlSet\\Control\\FileSystem' -Name 'LongPathsEnabled' -Value 1\n
    "},{"location":"installation.html#scoop","title":"Scoop","text":"

    Make sure you have installed scoop and verified that installed binaries are available in your $PATH before proceeding.

    Issues with komorebi and related commands not being recognized in the terminal ultimately come down to the $PATH environment variable not being correctly configured by your package manager and should not be raised as bugs or issues either on the komorebi GitHub repository or Discord server.

    "},{"location":"installation.html#install-komorebi-and-whkd","title":"Install komorebi and whkd","text":"

    First add the extras bucket

    scoop bucket add extras\n

    Then install the komorebi and whkd packages using scoop install

    scoop install komorebi whkd\n

    Once komorebi is installed, proceed to get the example configurations.

    "},{"location":"installation.html#winget","title":"WinGet","text":"

    Make sure you have installed the latest version of winget and verified that installed binaries are available in your $PATH before proceeding.

    Issues with komorebi and related commands not being recognized in the terminal ultimately come down to the $PATH environment variable not being correctly configured by your package manager and should not be raised as bugs or issues either on the komorebi GitHub repository or Discord server.

    "},{"location":"installation.html#install-komorebi-and-whkd_1","title":"Install komorebi and whkd","text":"

    Install the komorebi and whkd packages using winget install

    winget install LGUG2Z.komorebi\nwinget install LGUG2Z.whkd\n

    Once komorebi is installed, proceed to get the example configurations.

    "},{"location":"installation.html#building-from-source","title":"Building from source","text":"

    Make sure you have installed rustup, a stable rust compiler toolchain, and the Visual Studio Visual Studio prerequisites.

    Clone the git repository, enter the directory, and build the following binaries:

    cargo +stable install --path komorebi --locked\ncargo +stable install --path komorebic --locked\ncargo +stable install --path komorebic-no-console --locked\n

    If the binaries have been built and added to your $PATH correctly, you should see some output when running komorebi --help and komorebic --help

    "},{"location":"installation.html#offline","title":"Offline","text":"

    Download the latest komorebi and whkd MSI installers on an internet-connected computer, then copy them to an offline machine to install.

    Once installed, proceed to get the example configurations (none of the commands for first-time set up and running komorebi require an internet connection).

    "},{"location":"troubleshooting.html","title":"Troubleshooting","text":""},{"location":"troubleshooting.html#komorebi-is-unresponsive-when-the-display-wakes-from-sleep","title":"Komorebi is unresponsive when the display wakes from sleep","text":"

    This can happen in rare cases when your monitor state is not preserved after it wakes from sleep.

    "},{"location":"troubleshooting.html#problem","title":"Problem","text":"

    Your hotkeys in whkd work, but it feels as if komorebi knows nothing about the previous state (you can't control previous windows, although newly launched ones can be manipulated as normal).

    "},{"location":"troubleshooting.html#solution","title":"Solution","text":"

    Some monitors, such as the Samsung G8/G9 (LED, Neo, OLED) have an adaptive sync or variable refresh rate setting within the actual monitor OSD that can disrupt how the device is persisted in the komorebi state following suspension.

    To fix this, please try to disable Adaptive Sync or any other VRR branded alias by referring to the manufacturer's documentation.

    Warning

    Disabling VRR within Windows (e.g. Nvidia Control Panel) may work and can indeed change the configuration you see within your monitor's OSD, but some monitors will re-enable the setting regardless following suspension.

    "},{"location":"troubleshooting.html#reproducing","title":"Reproducing","text":"

    Ensure komorebi is in an operational state by executing komorebic start as normal.

    If komorebi is already unresponsive, then please restart komorebi first by running komorebic stop and komorebic start.

    1. komorebic state

      {\n\"monitors\": {\n\"elements\": [\n{\n\"id\": 65537,\n\"name\": \"DISPLAY1\",\n\"device\": \"SAM71AA\",\n\"device_id\": \"SAM71AA-5&a1a3e88&0&UID24834\",\n\"size\": {\n\"left\": 0,\n\"top\": 0,\n\"right\": 5120,\n\"bottom\": 1440\n}\n}\n]\n}\n}\n

      This appears to be fine -- komorebi is aware of the device and associated window handles.

    2. Let your display go to sleep.

      Simply turning the monitor off is not enough to reproduce the problem; you must let Windows turn off the display itself.

      To avoid waiting an eternity:

      • Control Panel -> Hardware and Sound -> Power Options -> Edit Plan Settings

      Turn off the display: 1 minute

      Allow a minute for the display to reset, then once it actually shuts off allow for any additional time as prompted by your monitor for the cycle to complete.

    3. Wake your display again by pressing any key.

      komorebi should now be unresponsive.

    4. komorebic state

      Don't stop komorebi just yet.

      Since it's unresponsive, you can open another shell instead to execute the above command.

      {\n\"monitors\": {\n\"elements\": [\n{\n\"id\": 65537,\n\"name\": \"DISPLAY1\",\n\"device\": null,\n\"device_id\": null,\n}\n]\n}\n}\n

      We can see the komorebi state is no longer associated with the previous device: null, suggesting an issue when the display resumes from a suspended state.

    "},{"location":"cli/active-window-border-colour.html","title":"active-window-border-colour","text":"
    Set the colour for the active window border\n\nUsage: komorebic.exe active-window-border-colour [OPTIONS] <R> <G> <B>\n\nArguments:\n  <R>\n          Red\n\n  <G>\n          Green\n\n  <B>\n          Blue\n\nOptions:\n  -w, --window-kind <WINDOW_KIND>\n          [default: single]\n          [possible values: single, stack, monocle]\n\n  -h, --help\n          Print help\n
    "},{"location":"cli/active-window-border-offset.html","title":"active-window-border-offset","text":"
    Set the offset for the active window border\n\nUsage: komorebic.exe active-window-border-offset <OFFSET>\n\nArguments:\n  <OFFSET>\n          Desired offset of the active window border\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/active-window-border-width.html","title":"active-window-border-width","text":"
    Set the width for the active window border\n\nUsage: komorebic.exe active-window-border-width <WIDTH>\n\nArguments:\n  <WIDTH>\n          Desired width of the active window border\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/active-window-border.html","title":"active-window-border","text":"
    Enable or disable the active window border\n\nUsage: komorebic.exe active-window-border <BOOLEAN_STATE>\n\nArguments:\n  <BOOLEAN_STATE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/adjust-container-padding.html","title":"adjust-container-padding","text":"
    Adjust container padding on the focused workspace\n\nUsage: komorebic.exe adjust-container-padding <SIZING> <ADJUSTMENT>\n\nArguments:\n  <SIZING>\n          [possible values: increase, decrease]\n\n  <ADJUSTMENT>\n          Pixels to adjust by as an integer\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/adjust-workspace-padding.html","title":"adjust-workspace-padding","text":"
    Adjust workspace padding on the focused workspace\n\nUsage: komorebic.exe adjust-workspace-padding <SIZING> <ADJUSTMENT>\n\nArguments:\n  <SIZING>\n          [possible values: increase, decrease]\n\n  <ADJUSTMENT>\n          Pixels to adjust by as an integer\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/ahk-app-specific-configuration.html","title":"ahk-app-specific-configuration","text":"
    Generate common app-specific configurations and fixes to use in komorebi.ahk\n\nUsage: komorebic.exe ahk-app-specific-configuration <PATH> [OVERRIDE_PATH]\n\nArguments:\n  <PATH>\n          YAML file from which the application-specific configurations should be loaded\n\n  [OVERRIDE_PATH]\n          Optional YAML file of overrides to apply over the first file\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/ahk-library.html","title":"ahk-library","text":"
    Generate a library of AutoHotKey helper functions\n\nUsage: komorebic.exe ahk-library\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/application-specific-configuration-schema.html","title":"application-specific-configuration-schema","text":"
    Generate a JSON Schema for applications.yaml\n\nUsage: komorebic.exe application-specific-configuration-schema\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/change-layout.html","title":"change-layout","text":"
    Set the layout on the focused workspace\n\nUsage: komorebic.exe change-layout <DEFAULT_LAYOUT>\n\nArguments:\n  <DEFAULT_LAYOUT>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/check.html","title":"check","text":"
    Check komorebi configuration and related files for common errors\n\nUsage: komorebic.exe check\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/clear-named-workspace-layout-rules.html","title":"clear-named-workspace-layout-rules","text":"
    Clear all dynamic layout rules for the specified workspace\n\nUsage: komorebic.exe clear-named-workspace-layout-rules <WORKSPACE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/clear-workspace-layout-rules.html","title":"clear-workspace-layout-rules","text":"
    Clear all dynamic layout rules for the specified workspace\n\nUsage: komorebic.exe clear-workspace-layout-rules <MONITOR> <WORKSPACE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/close.html","title":"close","text":"
    Close the focused window\n\nUsage: komorebic.exe close\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/complete-configuration.html","title":"complete-configuration","text":"
    Signal that the final configuration option has been sent\n\nUsage: komorebic.exe complete-configuration\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/configuration.html","title":"configuration","text":"
    Show the path to komorebi.json\n\nUsage: komorebic.exe configuration\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/container-padding.html","title":"container-padding","text":"
    Set the container padding for the specified workspace\n\nUsage: komorebic.exe container-padding <MONITOR> <WORKSPACE> <SIZE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <SIZE>\n          Pixels to pad with as an integer\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cross-monitor-move-behaviour.html","title":"cross-monitor-move-behaviour","text":"
    Set the behaviour when moving windows across monitor boundaries\n\nUsage: komorebic.exe cross-monitor-move-behaviour <MOVE_BEHAVIOUR>\n\nArguments:\n  <MOVE_BEHAVIOUR>\n          Possible values:\n          - swap:   Swap the window container with the window container at the edge of the adjacent monitor\n          - insert: Insert the window container into the focused workspace on the adjacent monitor\n\nOptions:\n  -h, --help\n          Print help (see a summary with '-h')\n
    "},{"location":"cli/cycle-focus.html","title":"cycle-focus","text":"
    Change focus to the window in the specified cycle direction\n\nUsage: komorebic.exe cycle-focus <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cycle-layout.html","title":"cycle-layout","text":"
    Cycle between available layouts\n\nUsage: komorebic.exe cycle-layout <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cycle-monitor.html","title":"cycle-monitor","text":"
    Focus the monitor in the given cycle direction\n\nUsage: komorebic.exe cycle-monitor <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cycle-move-to-monitor.html","title":"cycle-move-to-monitor","text":"
    Move the focused window to the monitor in the given cycle direction\n\nUsage: komorebic.exe cycle-move-to-monitor <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cycle-move-to-workspace.html","title":"cycle-move-to-workspace","text":"
    Move the focused window to the workspace in the given cycle direction\n\nUsage: komorebic.exe cycle-move-to-workspace <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cycle-move.html","title":"cycle-move","text":"
    Move the focused window in the specified cycle direction\n\nUsage: komorebic.exe cycle-move <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cycle-send-to-monitor.html","title":"cycle-send-to-monitor","text":"
    Send the focused window to the monitor in the given cycle direction\n\nUsage: komorebic.exe cycle-send-to-monitor <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cycle-send-to-workspace.html","title":"cycle-send-to-workspace","text":"
    Send the focused window to the workspace in the given cycle direction\n\nUsage: komorebic.exe cycle-send-to-workspace <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cycle-stack.html","title":"cycle-stack","text":"
    Cycle the focused stack in the specified cycle direction\n\nUsage: komorebic.exe cycle-stack <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/cycle-workspace.html","title":"cycle-workspace","text":"
    Focus the workspace in the given cycle direction\n\nUsage: komorebic.exe cycle-workspace <CYCLE_DIRECTION>\n\nArguments:\n  <CYCLE_DIRECTION>\n          [possible values: previous, next]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/disable-autostart.html","title":"disable-autostart","text":"
    Deletes the komorebi.lnk shortcut in shell:startup to disable autostart\n\nUsage: komorebic.exe disable-autostart\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/display-index-preference.html","title":"display-index-preference","text":"
    Set the display index preference for a monitor identified using its display name\n\nUsage: komorebic.exe display-index-preference <INDEX_PREFERENCE> <DISPLAY>\n\nArguments:\n  <INDEX_PREFERENCE>\n          Preferred monitor index (zero-indexed)\n\n  <DISPLAY>\n          Display name as identified in komorebic state\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/enable-autostart.html","title":"enable-autostart","text":"
    Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi\n\nUsage: komorebic.exe enable-autostart [OPTIONS]\n\nOptions:\n  -c, --config <CONFIG>\n          Path to a static configuration JSON file\n\n  -f, --ffm\n          Enable komorebi's custom focus-follows-mouse implementation\n\n      --whkd\n          Enable autostart of whkd\n\n      --ahk\n          Enable autostart of ahk\n\n  -h, --help\n          Print help\n
    "},{"location":"cli/ensure-named-workspaces.html","title":"ensure-named-workspaces","text":"
    Create these many named workspaces for the specified monitor\n\nUsage: komorebic.exe ensure-named-workspaces <MONITOR> [NAMES]...\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  [NAMES]...\n          Names of desired workspaces\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/ensure-workspaces.html","title":"ensure-workspaces","text":"
    Create at least this many workspaces for the specified monitor\n\nUsage: komorebic.exe ensure-workspaces <MONITOR> <WORKSPACE_COUNT>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE_COUNT>\n          Number of desired workspaces\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/fetch-app-specific-configuration.html","title":"fetch-app-specific-configuration","text":"
    Fetch the latest version of applications.yaml from komorebi-application-specific-configuration\n\nUsage: komorebic.exe fetch-app-specific-configuration\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/flip-layout.html","title":"flip-layout","text":"
    Flip the layout on the focused workspace (BSP only)\n\nUsage: komorebic.exe flip-layout <AXIS>\n\nArguments:\n  <AXIS>\n          [possible values: horizontal, vertical, horizontal-and-vertical]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/float-rule.html","title":"float-rule","text":"
    Add a rule to always float the specified application\n\nUsage: komorebic.exe float-rule <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/focus-follows-mouse.html","title":"focus-follows-mouse","text":"
    Enable or disable focus follows mouse for the operating system\n\nUsage: komorebic.exe focus-follows-mouse [OPTIONS] <BOOLEAN_STATE>\n\nArguments:\n  <BOOLEAN_STATE>\n          [possible values: enable, disable]\n\nOptions:\n  -i, --implementation <IMPLEMENTATION>\n          [default: windows]\n\n          Possible values:\n          - komorebi: A custom FFM implementation (slightly more CPU-intensive)\n          - windows:  The native (legacy) Windows FFM implementation\n\n  -h, --help\n          Print help (see a summary with '-h')\n
    "},{"location":"cli/focus-last-workspace.html","title":"focus-last-workspace","text":"
    Focus the last focused workspace on the focused monitor\n\nUsage: komorebic.exe focus-last-workspace\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/focus-monitor-workspace.html","title":"focus-monitor-workspace","text":"
    Focus the specified workspace on the target monitor\n\nUsage: komorebic.exe focus-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>\n\nArguments:\n  <TARGET_MONITOR>\n          Target monitor index (zero-indexed)\n\n  <TARGET_WORKSPACE>\n          Workspace index on the target monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/focus-monitor.html","title":"focus-monitor","text":"
    Focus the specified monitor\n\nUsage: komorebic.exe focus-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/focus-named-workspace.html","title":"focus-named-workspace","text":"
    Focus the specified workspace\n\nUsage: komorebic.exe focus-named-workspace <WORKSPACE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/focus-workspace.html","title":"focus-workspace","text":"
    Focus the specified workspace on the focused monitor\n\nUsage: komorebic.exe focus-workspace <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/focus-workspaces.html","title":"focus-workspaces","text":"
    Focus the specified workspace on all monitors\n\nUsage: komorebic.exe focus-workspaces <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/focus.html","title":"focus","text":"
    Change focus to the window in the specified direction\n\nUsage: komorebic.exe focus <OPERATION_DIRECTION>\n\nArguments:\n  <OPERATION_DIRECTION>\n          [possible values: left, right, up, down]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/focused-workspace-container-padding.html","title":"focused-workspace-container-padding","text":"
    Set container padding on the focused workspace\n\nUsage: komorebic.exe focused-workspace-container-padding <SIZE>\n\nArguments:\n  <SIZE>\n          Pixels size to set as an integer\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/focused-workspace-padding.html","title":"focused-workspace-padding","text":"
    Set workspace padding on the focused workspace\n\nUsage: komorebic.exe focused-workspace-padding <SIZE>\n\nArguments:\n  <SIZE>\n          Pixels size to set as an integer\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/force-focus.html","title":"force-focus","text":"
    Forcibly focus the window at the cursor with a left mouse click\n\nUsage: komorebic.exe force-focus\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/format-app-specific-configuration.html","title":"format-app-specific-configuration","text":"
    Format a YAML file for use with the 'ahk-app-specific-configuration' command\n\nUsage: komorebic.exe format-app-specific-configuration <PATH>\n\nArguments:\n  <PATH>\n          YAML file from which the application-specific configurations should be loaded\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/generate-static-config.html","title":"generate-static-config","text":"
    Generates a static configuration JSON file based on the current window manager state\n\nUsage: komorebic.exe generate-static-config\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/global-state.html","title":"global-state","text":"
    Show a JSON representation of the current global state\n\nUsage: komorebic.exe global-state\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/global-work-area-offset.html","title":"global-work-area-offset","text":"
    Set offsets to exclude parts of the work area from tiling\n\nUsage: komorebic.exe global-work-area-offset <LEFT> <TOP> <RIGHT> <BOTTOM>\n\nArguments:\n  <LEFT>\n          Size of the left work area offset (set right to left * 2 to maintain right padding)\n\n  <TOP>\n          Size of the top work area offset (set bottom to the same value to maintain bottom padding)\n\n  <RIGHT>\n          Size of the right work area offset\n\n  <BOTTOM>\n          Size of the bottom work area offset\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/identify-layered-application.html","title":"identify-layered-application","text":"
    Identify an application that has WS_EX_LAYERED, but should still be managed\n\nUsage: komorebic.exe identify-layered-application <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/identify-object-name-change-application.html","title":"identify-object-name-change-application","text":"
    Identify an application that sends EVENT_OBJECT_NAMECHANGE on launch\n\nUsage: komorebic.exe identify-object-name-change-application <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/identify-tray-application.html","title":"identify-tray-application","text":"
    Identify an application that closes to the system tray\n\nUsage: komorebic.exe identify-tray-application <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/initial-named-workspace-rule.html","title":"initial-named-workspace-rule","text":"
    Add a rule to associate an application with a named workspace on first show\n\nUsage: komorebic.exe initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\n  <WORKSPACE>\n          Name of a workspace\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/initial-workspace-rule.html","title":"initial-workspace-rule","text":"
    Add a rule to associate an application with a workspace on first show\n\nUsage: komorebic.exe initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/invisible-borders.html","title":"invisible-borders","text":"
    Set the invisible border dimensions around each window\n\nUsage: komorebic.exe invisible-borders <LEFT> <TOP> <RIGHT> <BOTTOM>\n\nArguments:\n  <LEFT>\n          Size of the left invisible border\n\n  <TOP>\n          Size of the top invisible border (usually 0)\n\n  <RIGHT>\n          Size of the right invisible border (usually left * 2)\n\n  <BOTTOM>\n          Size of the bottom invisible border (usually the same as left)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/load-custom-layout.html","title":"load-custom-layout","text":"
    Load a custom layout from file for the focused workspace\n\nUsage: komorebic.exe load-custom-layout <PATH>\n\nArguments:\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/load-resize.html","title":"load-resize","text":"
    Load the resize layout dimensions from a file\n\nUsage: komorebic.exe load-resize <PATH>\n\nArguments:\n  <PATH>\n          File from which the resize layout dimensions should be loaded\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/log.html","title":"log","text":"
    Tail komorebi.exe's process logs (cancel with Ctrl-C)\n\nUsage: komorebic.exe log\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/manage-rule.html","title":"manage-rule","text":"
    Add a rule to always manage the specified application\n\nUsage: komorebic.exe manage-rule <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/manage.html","title":"manage","text":"
    Force komorebi to manage the focused window\n\nUsage: komorebic.exe manage\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/minimize.html","title":"minimize","text":"
    Minimize the focused window\n\nUsage: komorebic.exe minimize\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/monitor-index-preference.html","title":"monitor-index-preference","text":"
    Set the monitor index preference for a monitor identified using its size\n\nUsage: komorebic.exe monitor-index-preference <INDEX_PREFERENCE> <LEFT> <TOP> <RIGHT> <BOTTOM>\n\nArguments:\n  <INDEX_PREFERENCE>\n          Preferred monitor index (zero-indexed)\n\n  <LEFT>\n          Left value of the monitor's size Rect\n\n  <TOP>\n          Top value of the monitor's size Rect\n\n  <RIGHT>\n          Right value of the monitor's size Rect\n\n  <BOTTOM>\n          Bottom value of the monitor's size Rect\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/monitor-work-area-offset.html","title":"monitor-work-area-offset","text":"
    Set offsets for a monitor to exclude parts of the work area from tiling\n\nUsage: komorebic.exe monitor-work-area-offset <MONITOR> <LEFT> <TOP> <RIGHT> <BOTTOM>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <LEFT>\n          Size of the left work area offset (set right to left * 2 to maintain right padding)\n\n  <TOP>\n          Size of the top work area offset (set bottom to the same value to maintain bottom padding)\n\n  <RIGHT>\n          Size of the right work area offset\n\n  <BOTTOM>\n          Size of the bottom work area offset\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/mouse-follows-focus.html","title":"mouse-follows-focus","text":"
    Enable or disable mouse follows focus on all workspaces\n\nUsage: komorebic.exe mouse-follows-focus <BOOLEAN_STATE>\n\nArguments:\n  <BOOLEAN_STATE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/move-to-monitor-workspace.html","title":"move-to-monitor-workspace","text":"
    Move the focused window to the specified monitor workspace\n\nUsage: komorebic.exe move-to-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>\n\nArguments:\n  <TARGET_MONITOR>\n          Target monitor index (zero-indexed)\n\n  <TARGET_WORKSPACE>\n          Workspace index on the target monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/move-to-monitor.html","title":"move-to-monitor","text":"
    Move the focused window to the specified monitor\n\nUsage: komorebic.exe move-to-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/move-to-named-workspace.html","title":"move-to-named-workspace","text":"
    Move the focused window to the specified workspace\n\nUsage: komorebic.exe move-to-named-workspace <WORKSPACE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/move-to-workspace.html","title":"move-to-workspace","text":"
    Move the focused window to the specified workspace\n\nUsage: komorebic.exe move-to-workspace <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/move-workspace-to-monitor.html","title":"move-workspace-to-monitor","text":"
    Move the focused workspace to the specified monitor\n\nUsage: komorebic.exe move-workspace-to-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/move.html","title":"move","text":"
    Move the focused window in the specified direction\n\nUsage: komorebic.exe move <OPERATION_DIRECTION>\n\nArguments:\n  <OPERATION_DIRECTION>\n          [possible values: left, right, up, down]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/named-workspace-container-padding.html","title":"named-workspace-container-padding","text":"
    Set the container padding for the specified workspace\n\nUsage: komorebic.exe named-workspace-container-padding <WORKSPACE> <SIZE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <SIZE>\n          Pixels to pad with as an integer\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/named-workspace-custom-layout-rule.html","title":"named-workspace-custom-layout-rule","text":"
    Add a dynamic custom layout for the specified workspace\n\nUsage: komorebic.exe named-workspace-custom-layout-rule <WORKSPACE> <AT_CONTAINER_COUNT> <PATH>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <AT_CONTAINER_COUNT>\n          The number of window containers on-screen required to trigger this layout rule\n\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/named-workspace-custom-layout.html","title":"named-workspace-custom-layout","text":"
    Set a custom layout for the specified workspace\n\nUsage: komorebic.exe named-workspace-custom-layout <WORKSPACE> <PATH>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/named-workspace-layout-rule.html","title":"named-workspace-layout-rule","text":"
    Add a dynamic layout rule for the specified workspace\n\nUsage: komorebic.exe named-workspace-layout-rule <WORKSPACE> <AT_CONTAINER_COUNT> <LAYOUT>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <AT_CONTAINER_COUNT>\n          The number of window containers on-screen required to trigger this layout rule\n\n  <LAYOUT>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/named-workspace-layout.html","title":"named-workspace-layout","text":"
    Set the layout for the specified workspace\n\nUsage: komorebic.exe named-workspace-layout <WORKSPACE> <VALUE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <VALUE>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/named-workspace-padding.html","title":"named-workspace-padding","text":"
    Set the workspace padding for the specified workspace\n\nUsage: komorebic.exe named-workspace-padding <WORKSPACE> <SIZE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <SIZE>\n          Pixels to pad with as an integer\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/named-workspace-rule.html","title":"named-workspace-rule","text":"
    Add a rule to associate an application with a named workspace\n\nUsage: komorebic.exe named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\n  <WORKSPACE>\n          Name of a workspace\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/named-workspace-tiling.html","title":"named-workspace-tiling","text":"
    Enable or disable window tiling for the specified workspace\n\nUsage: komorebic.exe named-workspace-tiling <WORKSPACE> <VALUE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\n  <VALUE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/new-workspace.html","title":"new-workspace","text":"
    Create and append a new workspace on the focused monitor\n\nUsage: komorebic.exe new-workspace\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/notification-schema.html","title":"notification-schema","text":"
    Generate a JSON Schema of subscription notifications\n\nUsage: komorebic.exe notification-schema\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/promote-focus.html","title":"promote-focus","text":"
    Promote the user focus to the top of the tree\n\nUsage: komorebic.exe promote-focus\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/promote.html","title":"promote","text":"
    Promote the focused window to the top of the tree\n\nUsage: komorebic.exe promote\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/pwsh-app-specific-configuration.html","title":"pwsh-app-specific-configuration","text":"
    Generate common app-specific configurations and fixes in a PowerShell script\n\nUsage: komorebic.exe pwsh-app-specific-configuration <PATH> [OVERRIDE_PATH]\n\nArguments:\n  <PATH>\n          YAML file from which the application-specific configurations should be loaded\n\n  [OVERRIDE_PATH]\n          Optional YAML file of overrides to apply over the first file\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/query.html","title":"query","text":"
    Query the current window manager state\n\nUsage: komorebic.exe query <STATE_QUERY>\n\nArguments:\n  <STATE_QUERY>\n          [possible values: focused-monitor-index, focused-workspace-index, focused-container-index, focused-window-index]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/quick-load-resize.html","title":"quick-load-resize","text":"
    Load the last quicksaved resize layout dimensions\n\nUsage: komorebic.exe quick-load-resize\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/quick-save-resize.html","title":"quick-save-resize","text":"
    Quicksave the current resize layout dimensions\n\nUsage: komorebic.exe quick-save-resize\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/quickstart.html","title":"quickstart","text":"
    Gather example configurations for a new-user quickstart\n\nUsage: komorebic.exe quickstart\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/reload-configuration.html","title":"reload-configuration","text":"
    Reload ~/komorebi.ahk (if it exists)\n\nUsage: komorebic.exe reload-configuration\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/remove-title-bar.html","title":"remove-title-bar","text":"
    Whitelist an application for title bar removal\n\nUsage: komorebic.exe remove-title-bar <IDENTIFIER> <ID>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/resize-axis.html","title":"resize-axis","text":"
    Resize the focused window or primary column along the specified axis\n\nUsage: komorebic.exe resize-axis <AXIS> <SIZING>\n\nArguments:\n  <AXIS>\n          [possible values: horizontal, vertical, horizontal-and-vertical]\n\n  <SIZING>\n          [possible values: increase, decrease]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/resize-delta.html","title":"resize-delta","text":"
    Set the resize delta (used by resize-edge and resize-axis)\n\nUsage: komorebic.exe resize-delta <PIXELS>\n\nArguments:\n  <PIXELS>\n          The delta of pixels by which to increase or decrease window dimensions when resizing\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/resize-edge.html","title":"resize-edge","text":"
    Resize the focused window in the specified direction\n\nUsage: komorebic.exe resize-edge <EDGE> <SIZING>\n\nArguments:\n  <EDGE>\n          [possible values: left, right, up, down]\n\n  <SIZING>\n          [possible values: increase, decrease]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/restore-windows.html","title":"restore-windows","text":"
    Restore all hidden windows (debugging command)\n\nUsage: komorebic.exe restore-windows\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/retile.html","title":"retile","text":"
    Force the retiling of all managed windows\n\nUsage: komorebic.exe retile\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/save-resize.html","title":"save-resize","text":"
    Save the current resize layout dimensions to a file\n\nUsage: komorebic.exe save-resize <PATH>\n\nArguments:\n  <PATH>\n          File to which the resize layout dimensions should be saved\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/send-to-monitor-workspace.html","title":"send-to-monitor-workspace","text":"
    Send the focused window to the specified monitor workspace\n\nUsage: komorebic.exe send-to-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>\n\nArguments:\n  <TARGET_MONITOR>\n          Target monitor index (zero-indexed)\n\n  <TARGET_WORKSPACE>\n          Workspace index on the target monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/send-to-monitor.html","title":"send-to-monitor","text":"
    Send the focused window to the specified monitor\n\nUsage: komorebic.exe send-to-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/send-to-named-workspace.html","title":"send-to-named-workspace","text":"
    Send the focused window to the specified workspace\n\nUsage: komorebic.exe send-to-named-workspace <WORKSPACE>\n\nArguments:\n  <WORKSPACE>\n          Target workspace name\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/send-to-workspace.html","title":"send-to-workspace","text":"
    Send the focused window to the specified workspace\n\nUsage: komorebic.exe send-to-workspace <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/socket-schema.html","title":"socket-schema","text":"
    Generate a JSON Schema of socket messages\n\nUsage: komorebic.exe socket-schema\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/stack.html","title":"stack","text":"
    Stack the focused window in the specified direction\n\nUsage: komorebic.exe stack <OPERATION_DIRECTION>\n\nArguments:\n  <OPERATION_DIRECTION>\n          [possible values: left, right, up, down]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/start.html","title":"start","text":"
    Start komorebi.exe as a background process\n\nUsage: komorebic.exe start [OPTIONS]\n\nOptions:\n  -f, --ffm\n          Allow the use of komorebi's custom focus-follows-mouse implementation\n\n  -c, --config <CONFIG>\n          Path to a static configuration JSON file\n\n  -a, --await-configuration\n          Wait for 'komorebic complete-configuration' to be sent before processing events\n\n  -t, --tcp-port <TCP_PORT>\n          Start a TCP server on the given port to allow the direct sending of SocketMessages\n\n      --whkd\n          Start whkd in a background process\n\n      --ahk\n          Start autohotkey configuration file\n\n  -h, --help\n          Print help\n
    "},{"location":"cli/state.html","title":"state","text":"
    Show a JSON representation of the current window manager state\n\nUsage: komorebic.exe state\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/static-config-schema.html","title":"static-config-schema","text":"
    Generate a JSON Schema of the static configuration file\n\nUsage: komorebic.exe static-config-schema\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/stop.html","title":"stop","text":"
    Stop the komorebi.exe process and restore all hidden windows\n\nUsage: komorebic.exe stop [OPTIONS]\n\nOptions:\n      --whkd\n          Stop whkd if it is running as a background process\n\n  -h, --help\n          Print help\n
    "},{"location":"cli/subscribe-pipe.html","title":"subscribe-pipe","text":"
    Subscribe to komorebi events using a Named Pipe\n\nUsage: komorebic.exe subscribe-pipe <NAMED_PIPE>\n\nArguments:\n  <NAMED_PIPE>\n          Name of the pipe to send event notifications to (without \"\\\\.\\pipe\\\" prepended)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/subscribe-socket.html","title":"subscribe-socket","text":"
    Subscribe to komorebi events using a Unix Domain Socket\n\nUsage: komorebic.exe subscribe-socket <SOCKET>\n\nArguments:\n  <SOCKET>\n          Name of the socket to send event notifications to\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/swap-workspaces-with-monitor.html","title":"swap-workspaces-with-monitor","text":"
    Swap focused monitor workspaces with specified monitor\n\nUsage: komorebic.exe swap-workspaces-with-monitor <TARGET>\n\nArguments:\n  <TARGET>\n          Target index (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/toggle-cross-monitor-move-behaviour.html","title":"toggle-cross-monitor-move-behaviour","text":"
    Toggle the behaviour when moving windows across monitor boundaries\n\nUsage: komorebic.exe toggle-cross-monitor-move-behaviour\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/toggle-float.html","title":"toggle-float","text":"
    Toggle floating mode for the focused window\n\nUsage: komorebic.exe toggle-float\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/toggle-focus-follows-mouse.html","title":"toggle-focus-follows-mouse","text":"
    Toggle focus follows mouse for the operating system\n\nUsage: komorebic.exe toggle-focus-follows-mouse [OPTIONS]\n\nOptions:\n  -i, --implementation <IMPLEMENTATION>\n          [default: windows]\n\n          Possible values:\n          - komorebi: A custom FFM implementation (slightly more CPU-intensive)\n          - windows:  The native (legacy) Windows FFM implementation\n\n  -h, --help\n          Print help (see a summary with '-h')\n
    "},{"location":"cli/toggle-maximize.html","title":"toggle-maximize","text":"
    Toggle native maximization for the focused window\n\nUsage: komorebic.exe toggle-maximize\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/toggle-monocle.html","title":"toggle-monocle","text":"
    Toggle monocle mode for the focused container\n\nUsage: komorebic.exe toggle-monocle\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/toggle-mouse-follows-focus.html","title":"toggle-mouse-follows-focus","text":"
    Toggle mouse follows focus on all workspaces\n\nUsage: komorebic.exe toggle-mouse-follows-focus\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/toggle-pause.html","title":"toggle-pause","text":"
    Toggle window tiling on the focused workspace\n\nUsage: komorebic.exe toggle-pause\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/toggle-tiling.html","title":"toggle-tiling","text":"
    Toggle window tiling on the focused workspace\n\nUsage: komorebic.exe toggle-tiling\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/toggle-title-bars.html","title":"toggle-title-bars","text":"
    Toggle title bars for whitelisted applications\n\nUsage: komorebic.exe toggle-title-bars\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/toggle-window-container-behaviour.html","title":"toggle-window-container-behaviour","text":"
    Toggle the behaviour for new windows (stacking or dynamic tiling)\n\nUsage: komorebic.exe toggle-window-container-behaviour\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/unmanage.html","title":"unmanage","text":"
    Unmanage a window that was forcibly managed\n\nUsage: komorebic.exe unmanage\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/unmanaged-window-operation-behaviour.html","title":"unmanaged-window-operation-behaviour","text":"
    Set the operation behaviour when the focused window is not managed\n\nUsage: komorebic.exe unmanaged-window-operation-behaviour <OPERATION_BEHAVIOUR>\n\nArguments:\n  <OPERATION_BEHAVIOUR>\n          Possible values:\n          - op:    Process komorebic commands on temporarily unmanaged/floated windows\n          - no-op: Ignore komorebic commands on temporarily unmanaged/floated windows\n\nOptions:\n  -h, --help\n          Print help (see a summary with '-h')\n
    "},{"location":"cli/unstack.html","title":"unstack","text":"
    Unstack the focused window\n\nUsage: komorebic.exe unstack\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/unsubscribe-pipe.html","title":"unsubscribe-pipe","text":"
    Unsubscribe from komorebi events\n\nUsage: komorebic.exe unsubscribe-pipe <NAMED_PIPE>\n\nArguments:\n  <NAMED_PIPE>\n          Name of the pipe to stop sending event notifications to (without \"\\\\.\\pipe\\\" prepended)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/unsubscribe-socket.html","title":"unsubscribe-socket","text":"
    Unsubscribe from komorebi events\n\nUsage: komorebic.exe unsubscribe-socket <SOCKET>\n\nArguments:\n  <SOCKET>\n          Name of the socket to stop sending event notifications to\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/visible-windows.html","title":"visible-windows","text":"
    Show a JSON representation of visible windows\n\nUsage: komorebic.exe visible-windows\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/watch-configuration.html","title":"watch-configuration","text":"
    Enable or disable watching of ~/komorebi.ahk (if it exists)\n\nUsage: komorebic.exe watch-configuration <BOOLEAN_STATE>\n\nArguments:\n  <BOOLEAN_STATE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/whkdrc.html","title":"whkdrc","text":"
    Show the path to whkdrc\n\nUsage: komorebic.exe whkdrc\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/window-hiding-behaviour.html","title":"window-hiding-behaviour","text":"
    Set the window behaviour when switching workspaces / cycling stacks\n\nUsage: komorebic.exe window-hiding-behaviour <HIDING_BEHAVIOUR>\n\nArguments:\n  <HIDING_BEHAVIOUR>\n          Possible values:\n          - hide:     Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps)\n          - minimize: Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching)\n          - cloak:    Use the undocumented SetCloak Win32 function to hide windows when switching workspaces (has foregrounding issues)\n\nOptions:\n  -h, --help\n          Print help (see a summary with '-h')\n
    "},{"location":"cli/workspace-custom-layout-rule.html","title":"workspace-custom-layout-rule","text":"
    Add a dynamic custom layout for the specified workspace\n\nUsage: komorebic.exe workspace-custom-layout-rule <MONITOR> <WORKSPACE> <AT_CONTAINER_COUNT> <PATH>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <AT_CONTAINER_COUNT>\n          The number of window containers on-screen required to trigger this layout rule\n\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/workspace-custom-layout.html","title":"workspace-custom-layout","text":"
    Set a custom layout for the specified workspace\n\nUsage: komorebic.exe workspace-custom-layout <MONITOR> <WORKSPACE> <PATH>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <PATH>\n          JSON or YAML file from which the custom layout definition should be loaded\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/workspace-layout-rule.html","title":"workspace-layout-rule","text":"
    Add a dynamic layout rule for the specified workspace\n\nUsage: komorebic.exe workspace-layout-rule <MONITOR> <WORKSPACE> <AT_CONTAINER_COUNT> <LAYOUT>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <AT_CONTAINER_COUNT>\n          The number of window containers on-screen required to trigger this layout rule\n\n  <LAYOUT>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/workspace-layout.html","title":"workspace-layout","text":"
    Set the layout for the specified workspace\n\nUsage: komorebic.exe workspace-layout <MONITOR> <WORKSPACE> <VALUE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <VALUE>\n          [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/workspace-name.html","title":"workspace-name","text":"
    Set the workspace name for the specified workspace\n\nUsage: komorebic.exe workspace-name <MONITOR> <WORKSPACE> <VALUE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <VALUE>\n          Name of the workspace as a String\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/workspace-padding.html","title":"workspace-padding","text":"
    Set the workspace padding for the specified workspace\n\nUsage: komorebic.exe workspace-padding <MONITOR> <WORKSPACE> <SIZE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <SIZE>\n          Pixels to pad with as an integer\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/workspace-rule.html","title":"workspace-rule","text":"
    Add a rule to associate an application with a workspace\n\nUsage: komorebic.exe workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>\n\nArguments:\n  <IDENTIFIER>\n          [possible values: exe, class, title, path]\n\n  <ID>\n          Identifier as a string\n\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"cli/workspace-tiling.html","title":"workspace-tiling","text":"
    Enable or disable window tiling for the specified workspace\n\nUsage: komorebic.exe workspace-tiling <MONITOR> <WORKSPACE> <VALUE>\n\nArguments:\n  <MONITOR>\n          Monitor index (zero-indexed)\n\n  <WORKSPACE>\n          Workspace index on the specified monitor (zero-indexed)\n\n  <VALUE>\n          [possible values: enable, disable]\n\nOptions:\n  -h, --help\n          Print help\n
    "},{"location":"common-workflows/active-window-border.html","title":"Active Window Border","text":"

    If you would like to add a visual border around the currently focused window, ensure the following options are defined in the komorebi.json configuration file.

    {\n\"active_window_border\": true,\n\"active_window_border_style\": \"Rounded\",\n\"active_window_border_colours\": {\n\"single\": {\n\"r\": 66,\n\"g\": 165,\n\"b\": 245\n},\n\"stack\": {\n\"r\": 256,\n\"g\": 165,\n\"b\": 66\n},\n\"monocle\": {\n\"r\": 255,\n\"g\": 51,\n\"b\": 153\n}\n},\n}\n

    It is important to note that the active window border will only apply to windows managed by komorebi.

    This feature is not considered stable, and you may encounter visual artifacts from time to time.

    "},{"location":"common-workflows/autohotkey.html","title":"AutoHotKey","text":"

    If you would like to use Autohotkey, please make sure you have AutoHotKey v2 installed.

    Generally, users who opt for AHK will have specific needs that can only be addressed by the advanced functionality of AHK, and so they are assumed to be able to craft their own configuration files.

    If you would like to try out AHK, a simple sample configuration powered by komorebic.lib.ahk is provided as a starting point. This sample configuration does not take into account the use of a static configuration file; if you choose to use a static configuration file alongside AHK, you can remove all the configuration options from your komorebi.ahk and use it solely to handle hotkey bindings.

    # save the latest generated komorebic library to ~/komorebic.lib.ahk\niwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebic.lib.ahk -OutFile $Env:USERPROFILE\\komorebic.lib.ahk\n\n# save the sample komorebi configuration file to ~/komorebi.ahk\niwr https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.20/komorebi.sample.ahk -OutFile $Env:USERPROFILE\\komorebi.ahk\n
    "},{"location":"common-workflows/custom-layouts.html","title":"Custom Layouts","text":"

    Particularly for users of ultrawide monitors, traditional tiling layouts may not seem like the most efficient use of screen space. If you feel this is the case with any of the default layouts, you are also welcome to create your own custom layouts and save them as JSON or YAML.

    If you're not comfortable writing the layouts directly in JSON or YAML, you can use the komorebi Custom Layout Generator to interactively define a custom layout, and then copy the generated JSON content.

    Custom layouts can be loaded on the current workspace or configured for a specific workspace in the komorebi.json configuration file.

    {\n\"monitors\": [\n{\n\"workspaces\": [\n{\n\"name\": \"personal\",\n\"custom_layout\": \"C:/Users/LGUG2Z/my-custom-layout.json\"\n},\n]\n}\n]\n}\n

    The fundamental building block of a custom komorebi layout is the Column.

    Columns come in three variants:

    • Primary: This is where your primary focus will be on the screen most of the time. There must be exactly one Primary Column in any custom layout. Optionally, you can specify the percentage of the screen width that you want the Primary Column to occupy.
    • Secondary: This is an optional column that can either be full height of split horizontally into a fixed number of maximum rows. There can be any number of Secondary Columns in a custom layout.
    • Tertiary: This is the final column where any remaining windows will be split horizontally into rows as they get added.

    If there is only one window on the screen when a custom layout is selected, that window will take up the full work area of the screen.

    If the number of windows is equal to or less than the total number of columns defined in a custom layout, the windows will be arranged in an equal-width columns.

    When the number of windows is greater than the number of columns defined in the custom layout, the windows will begin to be arranged according to the constraints set on the Primary and Secondary columns of the layout.

    Here is an example custom layout that can be used as a starting point for your own:

    - column: Secondary\nconfiguration: !Horizontal 2 # max number of rows\n- column: Primary\nconfiguration: !WidthPercentage 50 # percentage of screen\n- column: Tertiary\nconfiguration: Horizontal\n

    "},{"location":"common-workflows/dynamic-layout-switching.html","title":"Dynamically Layout Switching","text":"

    With komorebi it is possible to define rules to automatically change the layout on a specified workspace when a threshold of window containers is met.

    {\n\"monitors\": [\n{\n\"workspaces\": [\n{\n\"name\": \"personal\",\n\"layout_rules\": {\n\"1\": \"BSP\"\n}\n\"custom_layout_rules\": {\n\"5\": \"C:/Users/LGUG2Z/my-custom-layout.json\"\n}\n},\n]\n}\n]\n}\n

    In this example, when there are one or more window containers visible on the screen, the BSP layout is used, and when there are five or more window containers visible, a custom layout is used.

    However, if you add workspace layout rules, you will not be able to manually change the layout of a workspace until all layout rules for that workspace have been cleared.

    # for example, to clear rules from monitor 0, workspace 0\nkomorebic clear-workspace-layout-rules 0 0\n
    "},{"location":"common-workflows/focus-follows-mouse.html","title":"Focus Follows Mouse","text":"

    komorebi supports two focus-follows-mouse implementations; the native Windows Xmouse implementation, which treats the desktop, the task bar, and the system tray as windows and switches focus to them eagerly, and a custom komorebi implementation, which only considers windows managed by komorebi as valid targets to switch focus to when moving the mouse.

    To enable the komorebi implementation you must start the process with the --ffm flag to explicitly enable the feature. This is because the mouse tracking required for this feature significantly increases the CPU usage of the process (on my machine, it jumps from <1% to ~4~), and this CPU increase persists regardless of whether focus-follows-mouse is enabled or disabled at any given time via komorebic's configuration commands.

    If the komorebi process has been started with the --ffm flag, you can enable focus follows mouse behaviour in the komorebi.json configuration file.

    {\n\"focus_follows_mouse\": \"Komorebi\"\n}\n

    When calling any of the komorebic commands related to focus-follows-mouse functionality, the windows implementation will be chosen as the default implementation. You can optionally specify the komorebi implementation by passing it as an argument to the --implementation flag:

    komorebic.exe toggle-focus-follows-mouse --implementation komorebi\n
    "},{"location":"common-workflows/force-manage-windows.html","title":"Force Manage Windows","text":"

    \u2757\ufe0fNOTE: A significant number of force-manage window rules for the most common applications are already generated for you

    In some rare cases, a window may not automatically be registered to be managed by komorebi. You can add rules to enforce this behaviour in the komorebi.json configuration file.

    {\n\"manage_rules\": [\n{\n\"kind\": \"Title\",\n\"id\": \"Media Player\",\n\"matching_strategy\": \"Equals\"\n}\n]\n}\n
    "},{"location":"common-workflows/ignore-windows.html","title":"Ignore Windows","text":"

    \u2757\ufe0fNOTE: A significant number of ignored window rules for the most common applications are already generated for you

    Sometimes you will want a specific application to never be tiled, and instead float all the time. You can add rules to enforce this behaviour in the komorebi.json configuration file.

    {\n\"float_rules\": [\n{\n\"kind\": \"Title\",\n\"id\": \"Media Player\",\n\"matching_strategy\": \"Equals\"\n}\n]\n}\n
    "},{"location":"common-workflows/komorebi-config-home.html","title":"KOMOREBI_CONFIG_HOME","text":"

    If you do not want to keep komorebi-related files in your $Env:USERPROFILE directory, you can specify a custom directory by setting the $Env:KOMOREBI_CONFIG_HOME environment variable.

    For example, to use the ~/.config/komorebi directory:

    # Run this command to make sure that the directory has been created\nmkdir -p ~/.config/komorebi\n\n# Run this command to open up your PowerShell profile configuration in Notepad\nnotepad $PROFILE\n\n# Add this line (with your login user!) to the bottom of your PowerShell profile configuration\n$Env:KOMOREBI_CONFIG_HOME = 'C:\\Users\\LGUG2Z\\.config\\komorebi'\n\n# Save the changes and then reload the PowerShell profile\n. $PROFILE\n

    If you already have configuration files that you wish to keep, move them to the ~/.config/komorebi directory.

    The next time you run komorebic start, any files created by or loaded by komorebi will be placed or expected to exist in this folder.

    "},{"location":"common-workflows/mouse-follows-focus.html","title":"Mouse Follows Focus","text":"

    By default, the mouse will move to the center of the window when the focus is changed in a given direction. This behaviour is know as 'mouse follows focus'. This behaviour can be disabled in the komorebi.json configuration file.

    {\n\"mouse_follows_focus\": false,\n}\n

    "},{"location":"common-workflows/remove-gaps.html","title":"Remove Gaps","text":"

    If you would like to remove all gaps by default, both between windows themselves, and between the monitor edges and the windows, you can set the following configuration options to 0 and -1 in the komorebi.json configuration file.

    {\n\"default_workspace_padding\": 0,\n\"default_container_padding\": 0,\n\"border_width\": 0,\n\"border_offset\": -1\n}\n

    A restart of komorebi is required after changing these settings.

    "},{"location":"common-workflows/stackbar.html","title":"Stackbar","text":"

    If you would like to add a visual stackbar to show which windows are in a container stack ensure the following options are defined in the komorebi.json configuration file.

    {\n\"stackbar\": {\n\"height\": 40,\n\"mode\": \"OnStack\",\n\"tabs\": {\n\"width\": 300,\n\"focused_text\": \"#00a542\",\n\"unfocused_text\": \"#b3b3b3\",\n\"background\": \"#141414\"\n}\n}\n}\n

    This feature is not considered stable, and you may encounter visual artifacts from time to time.

    "},{"location":"common-workflows/tray-and-multi-window-applications.html","title":"Tray and Multi-Window Applications","text":"

    \u2757\ufe0fNOTE: A significant number of tray and multi-window application rules for the most common applications are already generated for you

    If you are experiencing behaviour where closing a window leaves a blank tile, but minimizing the same window does not, you have probably enabled a 'close/minimize to tray' option for that application. You can tell komorebi to handle this application appropriately by identifying it via the executable name or the window class.

    {\n\"tray_and_multi_window_applications\": [\n{\n\"kind\": \"Class\",\n\"id\": \"SDL_app\",\n\"matching_strategy\": \"Equals\"\n}\n]\n}\n
    "},{"location":"release/v0-1-22.html","title":"V0 1 22","text":"

    In addition to the changelog of new features and fixes, please note the following changes from v0.1.21 to adjust your configuration files accordingly.

    "},{"location":"release/v0-1-22.html#tldr","title":"tl;dr","text":"

    The way windows are sized and drawn has been improved to remove the need to manually specify and remove invisible borders for applications that overflow them. If you use the active window border, the first time you launch v0.1.22 you may end up with a huge border due to these changes.

    active_window_border_width and active_window_border_offset have been renamed to border_width and border_offset as they now also apply outside the context of the active window border.

    {\n\"active_window_border\": true,\n\"border_width\": 8,\n\"border_offset\": -1\n}\n

    Users of the active window border should start from these settings and read the notes below before making further adjustments.

    "},{"location":"release/v0-1-22.html#changes-to-active_window_border-and-window-sizing","title":"Changes to active_window_border, and window sizing:","text":"
    • The border no longer creates a second drop-shadow around the active window
    • Windows are now sized to fill the layout region entirely, ignoring window decorations such as drop shadows
    • Border offset now starts exactly at the paint edge of the window on all sides
    • Windows are sized such that the border offset and border width are taken into account
    "},{"location":"release/v0-1-22.html#recommended-patterns","title":"Recommended patterns","text":""},{"location":"release/v0-1-22.html#gapless","title":"Gapless","text":"
    • Disable \"transparency effects\" Personalization > Colors
    • Set the following settings in komorebi.json: 
      {\n\"default_workspace_padding\": 0,\n\"default_container_padding\": 0,\n\"border_offset\": -1,\n\"border_width\": 0\n}\n
    "},{"location":"release/v0-1-22.html#1px-border","title":"1px border","text":"

    A 1px border is drawn around the window edge. Users may see a gap for a single pixel, if the system theme has a transparent edge - this is the windows themed edge, and is not present for all applications.

      {\n\"border_offset\": 0,\n\"border_width\": 1\n}\n
    "}]} \ No newline at end of file diff --git a/troubleshooting.html b/troubleshooting.html new file mode 100644 index 00000000..92e4f9de --- /dev/null +++ b/troubleshooting.html @@ -0,0 +1,4351 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Troubleshooting - Komorebi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + + + + +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + + + + + + + + + + + + + + + + +

    Troubleshooting

    +

    Komorebi is unresponsive when the display wakes from sleep

    +

    This can happen in rare cases when your monitor state is not preserved after it +wakes from sleep.

    +

    Problem

    +

    Your hotkeys in whkd work, but it feels as if komorebi knows nothing about +the previous state (you can't control previous windows, although newly launched ones +can be manipulated as normal).

    +

    Solution

    +

    Some monitors, such as the Samsung G8/G9 (LED, Neo, OLED) have an adaptive +sync or variable refresh rate setting within the actual monitor OSD that can +disrupt how the device is persisted in the komorebi state following suspension.

    +

    To fix this, please try to disable Adaptive Sync or any other VRR branded +alias by referring to the manufacturer's documentation.

    +
    +

    Warning

    +

    Disabling VRR within Windows (e.g. Nvidia Control Panel) may work and can indeed +change the configuration you see within your monitor's OSD, but some monitors +will re-enable the setting regardless following suspension.

    +
    +

    Reproducing

    +

    Ensure komorebi is in an operational state by executing komorebic start as +normal.

    +

    If komorebi is already unresponsive, then please restart komorebi first by +running komorebic stop and komorebic start.

    +
      +
    1. +

      komorebic state

      +
      {
+  "monitors": {
+    "elements": [
+      {
+        "id": 65537,
+        "name": "DISPLAY1",
+        "device": "SAM71AA",
+        "device_id": "SAM71AA-5&a1a3e88&0&UID24834",
+        "size": {
+          "left": 0,
+          "top": 0,
+          "right": 5120,
+          "bottom": 1440
+        }
+      }
+    ]
+  }
+}
+
      +

      This appears to be fine -- komorebi is aware of the device and associated +window handles.

      +
      2. +
    2. +

      Let your display go to sleep.

      +

      Simply turning the monitor off is not enough to reproduce the problem; you must +let Windows turn off the display itself.

      +

      To avoid waiting an eternity:

      +
        +
      • Control Panel -> Hardware and Sound -> Power Options -> Edit Plan + Settings
        • +
      +

      Turn off the display: 1 minute

      +

      Allow a minute for the display to reset, then once it actually shuts off +allow for any additional time as prompted by your monitor for the cycle to +complete.

      +
      3. +
    3. +

      Wake your display again by pressing any key.

      +

      komorebi should now be unresponsive.

      +
      4. +
    4. +

      komorebic state

      +

      Don't stop komorebi just yet.

      +

      Since it's unresponsive, you can open another shell instead to execute the above command.

      +
      {
+  "monitors": {
+    "elements": [
+      {
+        "id": 65537,
+        "name": "DISPLAY1",
+        "device": null,
+        "device_id": null,
+      }
+    ]
+  }
+}
+
      +

      We can see the komorebi state is no longer associated with the previous +device: null, suggesting an issue when the display resumes from a suspended +state.

      +
      5. +
    + + + + + + +
    +
    + + + + +
    + + + +
    + + + +
    +
    +
    +
    + + + + + + + + + \ No newline at end of file