Komorebi

https://lgug2z.github.io/komorebi/
Admin
Komorebi is a tiling window manager for Windows 10 and above that extends Microsoft's Desktop Window...
Tokens:59,065
Snippets:789
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Komorebi CLI Quickstart Command

Source: https://lgug2z.github.io/komorebi/cli/quickstart.html?q=

Use this command to gather example configurations for a new-user quickstart. It displays available options for help.

```bash
komorebic.exe quickstart

Options:
  -h, --help
          Print help

```

--------------------------------

### Run Komorebi Quickstart Command

Source: https://lgug2z.github.io/komorebi/cli/quickstart.html

Use this command to gather example configurations for a new-user quickstart. It prints available options for help.

```bash
komorebic.exe quickstart
```

--------------------------------

### Get Komorebi Start Help

Source: https://lgug2z.github.io/komorebi/cli/start.html?q=

Prints the help message for the 'komorebic start' command, detailing all available options.

```bash
komorebic start -h
```

--------------------------------

### Start Komorebi with Configuration File

Source: https://lgug2z.github.io/komorebi/cli/start.html?q=

Specify a static configuration JSON file to be used when starting Komorebi.

```bash
komorebic start -c CONFIG
```

--------------------------------

### Download Example Configurations

Source: https://lgug2z.github.io/komorebi/example-configurations.html?q=

Run this command to download example configuration files for Komorebi and whkd. Check the output for the download location, typically in your user profile directory.

```bash
komorebic quickstart

```

--------------------------------

### Start Komorebi

Source: https://lgug2z.github.io/komorebi/troubleshooting.html?q=

Execute this command to start Komorebi in an operational state for testing.

```bash
komorebic start
```

--------------------------------

### Start Komorebi with AutoHotKey Support

Source: https://lgug2z.github.io/komorebi/troubleshooting.html

This command attempts to start Komorebi with AutoHotKey integration. Ensure AutoHotKey is installed, preferably via scoop, to avoid errors.

```bash
komorebic start --ahk
```

--------------------------------

### Install Komorebi with WinGet

Source: https://lgug2z.github.io/komorebi/installation.html?q=

Install the Komorebi window manager using WinGet.

```powershell
winget install LGUG2Z.komorebi

```

--------------------------------

### Start Komorebi with Whkd

Source: https://lgug2z.github.io/komorebi/cli/start.html?q=

Launches whkd in a background process alongside Komorebi.

```bash
komorebic start --whkd
```

--------------------------------

### Install whkd with WinGet

Source: https://lgug2z.github.io/komorebi/installation.html?q=

Install the whkd hotkey daemon using WinGet.

```powershell
winget install LGUG2Z.whkd

```

--------------------------------

### Start Komorebi with Komorebi-Bar

Source: https://lgug2z.github.io/komorebi/cli/start.html?q=

Starts komorebi-bar in a background process.

```bash
komorebic start --bar
```

--------------------------------

### Start Komorebi and Wait for Configuration

Source: https://lgug2z.github.io/komorebi/cli/start.html?q=

This option makes Komorebi wait for a 'komorebic complete-configuration' command before processing events, useful for dynamic configuration setups.

```bash
komorebic start -a
```

--------------------------------

### Install Komorebi and whkd with WinGet

Source: https://lgug2z.github.io/komorebi/installation.html

Install the Komorebi window manager and the whkd hotkey daemon using the WinGet package manager.

```powershell
winget install LGUG2Z.komorebi
winget install LGUG2Z.whkd

```

--------------------------------

### Install Komorebi and whkd with Scoop

Source: https://lgug2z.github.io/komorebi/installation.html

Install the Komorebi window manager and the whkd hotkey daemon using the Scoop package manager.

```powershell
scoop install komorebi whkd

```

--------------------------------

### Start Komorebi with whkd and Status Bar

Source: https://lgug2z.github.io/komorebi/example-configurations.html?q=

Start Komorebi, whkd, and the Komorebi status bar using this command. Omit the `--bar` flag if you do not wish to use the status bar.

```bash
komorebic start --whkd --bar

```

--------------------------------

### Start Komorebi with Options

Source: https://lgug2z.github.io/komorebi/cli/start.html

Launches komorebi.exe as a background process. Use options to specify a configuration file, wait for configuration completion, start a TCP server, or launch auxiliary tools like whkd, komorebi-bar, or masir. The '--clean-state' flag prevents loading a previous session's state.

```bash
komorebic.exe start [OPTIONS]
```

--------------------------------

### Komorebi Grid Layout Examples

Source: https://lgug2z.github.io/komorebi/example-configurations.html

These examples demonstrate the grid layout, similar to LeftWM's grid, which does not support resizing window tiles.

```text
+-----+-----+
|     |     |
|     |     |
+-----+-----+
  4 windows

```

```text
+---+---+---+
|   |   |   |
|   |   |   |
|   +---+---|
|   |   |   |
|   |   |   |
+---+---+---+
  5 windows

```

```text
+---+---+---+
|   |   |   |
|   |   |   |
+---+---+---+
|   |   |   |
|   |   |   |
+---+---+---+
  6 windows

```

```text
+---+---+---+
|   |   |   |
|   |   |   |
+---+---|   |
|   |   +---|
|   |   |   |
+---+---+---+
  7 windows

```

--------------------------------

### Start Komorebi with TCP Server

Source: https://lgug2z.github.io/komorebi/cli/start.html?q=

Starts a TCP server on a specified port, allowing direct sending of SocketMessages to Komorebi.

```bash
komorebic start -t TCP_PORT
```

--------------------------------

### Move Window to Workspace with Help Option

Source: https://lgug2z.github.io/komorebi/cli/move-to-workspace.html

This example demonstrates how to access the help information for the `move-to-workspace` command, which includes details on arguments and options.

```bash
komorebic.exe move-to-workspace -h
```

--------------------------------

### Enable Autostart with Configuration

Source: https://lgug2z.github.io/komorebi/cli/enable-autostart.html

Enables autostart for Komorebi while specifying a custom configuration file. This is useful for managing different Komorebi setups.

```bash
komorebic.exe enable-autostart -c C:\path\to\static.json
```

--------------------------------

### Start Komorebi Command Usage

Source: https://lgug2z.github.io/komorebi/cli/start.html?q=

Use this command to start komorebi.exe as a background process. It accepts various options to configure its behavior.

```bash
komorebic start [OPTIONS]
```

--------------------------------

### Start Komorebi

Source: https://lgug2z.github.io/komorebi/cli/start.html

Starts komorebi.exe as a background process. You can specify a configuration file, wait for configuration completion, enable a TCP server, or launch additional components like whkd, komorebi-bar, or masir.

```APIDOC
## start komorebi.exe

### Description
Starts komorebi.exe as a background process.

### Usage
`komorebic.exe start [OPTIONS]`

### Options
#### Path Parameters
- **-c, --config <CONFIG>** (string) - Required - Path to a static configuration JSON file

#### Query Parameters
- **-a, --await-configuration** - Optional - Wait for 'komorebic complete-configuration' to be sent before processing events
- **-t, --tcp-port <TCP_PORT>** (integer) - Optional - Start a TCP server on the given port to allow the direct sending of SocketMessages
- **--whkd** - Optional - Start whkd in a background process
- **--bar** - Optional - Start komorebi-bar in a background process
- **--masir** - Optional - Start masir in a background process for focus-follows-mouse
- **--clean-state** - Optional - Do not attempt to auto-apply a dumped state temp file from a previously running instance of komorebi
- **-h, --help** - Optional - Print help
```

--------------------------------

### Start Komorebi with Masir for Focus-Follows-Mouse

Source: https://lgug2z.github.io/komorebi/cli/start.html?q=

Launches masir in a background process to enable the focus-follows-mouse behavior.

```bash
komorebic start --masir
```

--------------------------------

### Enable Komorebi Autostart

Source: https://lgug2z.github.io/komorebi/common-workflows/autostart.html

Use this command to generate a shortcut in the `shell:startup` folder for Komorebi. This ensures Komorebi starts automatically when you log in to Windows. You can optionally specify a configuration file, enable focus-follows-mouse, or autostart companion applications like whkd, ahk, or komorebi-bar.

```bash
Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi

Usage: komorebic.exe enable-autostart [OPTIONS]

Options:
  -c, --config <CONFIG>
          Path to a static configuration JSON file

  -f, --ffm
          Enable komorebi's custom focus-follows-mouse implementation

      --whkd
          Enable autostart of whkd

      --ahk
          Enable autostart of ahk

      --bar
          Enable autostart of komorebi-bar

  -h, --help
          Print help

```

--------------------------------

### Add Extras Bucket for Scoop

Source: https://lgug2z.github.io/komorebi/installation.html

Before installing Komorebi and whkd with Scoop, add the 'extras' bucket to your package manager.

```powershell
scoop bucket add extras

```

--------------------------------

### Komorebi Grid Layout Examples

Source: https://lgug2z.github.io/komorebi/example-configurations.html?q=

Illustrates Komorebi's grid layout with varying numbers of windows.

```text
+-----+-----+
|     |     |
|     |     |
+-----+-----+
|     |     |
|     |     |
+-----+-----+
  4 windows
```

```text
+---+---+---+
|   |   |   |
|   |   |
|   +---+---+
|   |   |   |
|   |   |   |
+---+---+---+
  5 windows
```

```text
+---+---+---+
|   |   |   |
|   |   |   |
+---+---+---+
|   |   |   |
|   |   |   |
+---+---+---+
  6 windows
```

```text
+---+---+---+
|   |   |   |
|   |   +---|
+---+---|   |
|   |   +---|
|   |   |   |
+---+---+---+
  7 windows
```

--------------------------------

### Komorebi Bar Configuration for Monitor 1

Source: https://lgug2z.github.io/komorebi/common-workflows/multi-monitor-setup.html?q=

Example configuration for a Komorebi bar targeting the first monitor (index 0).

```json
{
  "monitor_index": 0
  //...
}
```

--------------------------------

### Start Komorebi with Clean State

Source: https://lgug2z.github.io/komorebi/cli/start.html?q=

Prevents Komorebi from attempting to auto-apply a dumped state file from a previous instance, ensuring a clean start.

```bash
komorebic start --clean-state
```

--------------------------------

### Build Komorebi Binaries from Source

Source: https://lgug2z.github.io/komorebi/installation.html?q=

Build all Komorebi-related binaries from source using Cargo. Ensure you have Rust and Visual Studio prerequisites installed.

```rust
cargo +stable install --path komorebi --locked

```

```rust
cargo +stable install --path komorebic --locked

```

```rust
cargo +stable install --path komorebic-no-console --locked

```

```rust
cargo +stable install --path komorebi-gui --locked

```

```rust
cargo +stable install --path komorebi-bar --locked

```

```rust
cargo +stable install --path komorebi-shortcuts --locked

```

--------------------------------

### Komorebi Bar Configuration for Monitor 2

Source: https://lgug2z.github.io/komorebi/common-workflows/multi-monitor-setup.html?q=

Example configuration for a Komorebi bar targeting the second monitor (index 1).

```json
{
  "monitor_index": 1
  //...
}
```

--------------------------------

### Clean Up Komorebi Runtime Files

Source: https://lgug2z.github.io/komorebi/installation.html

Run these commands in PowerShell to remove configuration and runtime files created by Komorebi and quickstart.

```powershell
rm $Env:USERPROFILE\komorebi.json
rm $Env:USERPROFILE\applications.json
rm $Env:USERPROFILE\.config\whkdrc
rm -r -Force $Env:LOCALAPPDATA\komorebi
```

--------------------------------

### Add Window Management Rule

Source: https://lgug2z.github.io/komorebi/common-workflows/force-manage-windows.html?q=

Use the `manage_rules` array in `komorebi.json` to specify windows that should always be managed. This example adds a rule for 'Media Player' using an exact title match.

```json
{
  "manage_rules": [
    {
      "kind": "Title",
      "id": "Media Player",
      "matching_strategy": "Equals"
    }
  ]
}

```

--------------------------------

### Komorebi Bar Configuration for Monitor 3

Source: https://lgug2z.github.io/komorebi/common-workflows/multi-monitor-setup.html?q=

Example configuration for a Komorebi bar targeting the third monitor (index 2).

```json
{
  "monitor_index": 2
  //...
}
```

--------------------------------

### Uninstall Komorebi with WinGet

Source: https://lgug2z.github.io/komorebi/installation.html?q=

Use this command to uninstall Komorebi and whkd if you installed them using WinGet.

```bash
winget uninstall LGUG2Z.komorebi LGUG2Z.whkd
```

--------------------------------

### Build Komorebi Binaries from Source

Source: https://lgug2z.github.io/komorebi/installation.html

Compile Komorebi and its related binaries from source using Cargo. Ensure you have Rust and Visual Studio prerequisites installed.

```rust
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-gui --locked
cargo +stable install --path komorebi-bar --locked
cargo +stable install --path komorebi-shortcuts --locked

```

--------------------------------

### Simplified Monitor Configuration

Source: https://lgug2z.github.io/komorebi/common-workflows/multi-monitor-setup.html?q=

A simplified monitor configuration with three workspaces. This can be used as a starting point for your `komorebi.json`.

```json
{
  "monitors": [
    {
      "workspaces": [
        {
          "name": "I",
          "layout": "BSP"
        },
        {
          "name": "II",
          "layout": "VerticalStack"
        },
        {
          "name": "III",
          "layout": "HorizontalStack"
        }
      ]
    }
  ]
}
```

--------------------------------

### Configure Floating Applications in Komorebi

Source: https://lgug2z.github.io/komorebi/common-workflows/floating-applications.html

Add rules to the `komorebi.json` configuration file to specify applications that should always be managed as floating windows. This example targets an application with the exact title 'Media Player'.

```json
{
  "floating_applications": [
    {
      "kind": "Title",
      "id": "Media Player",
      "matching_strategy": "Equals"
    }
  ]
}

```

--------------------------------

### Configure Ignored Window Rules

Source: https://lgug2z.github.io/komorebi/common-workflows/ignore-windows.html

Add rules to `komorebi.json` to prevent specific windows from being tiled. This example ignores windows with the exact title 'Media Player'.

```json
{
  "ignore_rules": [
    {
      "kind": "Title",
      "id": "Media Player",
      "matching_strategy": "Equals"
    }
  ]
}
```

--------------------------------

### Komorebi State Before Display Sleep

Source: https://lgug2z.github.io/komorebi/troubleshooting.html

Example output of `komorebic state` showing a recognized monitor. This is the expected state before a display goes to sleep.

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

--------------------------------

### Find Invisible Window Details with `komorebic visible-windows`

Source: https://lgug2z.github.io/komorebi/troubleshooting.html

Use this command to get details about invisible windows that may be causing phantom tiles. These details can then be used to create a rule to ignore such windows.

```bash
komorebic visible-windows
```

--------------------------------

### Display Help for Enable Autostart

Source: https://lgug2z.github.io/komorebi/cli/enable-autostart.html

Prints the help message for the `enable-autostart` command, detailing all available options and their usage. This is useful for understanding the command's full capabilities.

```bash
komorebic.exe enable-autostart -h
```

--------------------------------

### Add Window Management Rule

Source: https://lgug2z.github.io/komorebi/common-workflows/force-manage-windows.html

Add a rule to the `manage_rules` array in `komorebi.json` to force Komorebi to manage a window. This example uses `Title` matching strategy for a window with the exact title 'Media Player'.

```json
{
  "manage_rules": [
    {
      "kind": "Title",
      "id": "Media Player",
      "matching_strategy": "Equals"
    }
  ]
}
```

--------------------------------

### Enable Autostart

Source: https://lgug2z.github.io/komorebi/cli/enable-autostart.html?q=

Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi.

```APIDOC
## enable-autostart

### Description
Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi.

### Usage
`komorebic.exe enable-autostart [OPTIONS]`

### Options
#### Optional Arguments
- `-c, --config <CONFIG>`: Path to a static configuration JSON file.
- `--whkd`: Enable autostart of whkd.
- `--bar`: Enable autostart of komorebi-bar.
- `--masir`: Enable autostart of masir.
- `-h, --help`: Print help.
```

--------------------------------

### Enable Autostart

Source: https://lgug2z.github.io/komorebi/cli/enable-autostart.html

This command generates the necessary shortcut to autostart Komorebi when your system boots up. You can also specify options to autostart additional components.

```APIDOC
## enable-autostart

### Description
Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi.

### Usage
`komorebic.exe enable-autostart [OPTIONS]`

### Options
#### Configuration
- `-c, --config <CONFIG>`: Path to a static configuration JSON file.

#### Autostart Components
- `--whkd`: Enable autostart of whkd.
- `--bar`: Enable autostart of komorebi-bar.
- `--masir`: Enable autostart of masir.

#### Help
- `-h, --help`: Print help information.
```

--------------------------------

### Enable Komorebi Autostart

Source: https://lgug2z.github.io/komorebi/common-workflows/autostart.html?q=

Use this command to generate a shortcut in the `shell:startup` folder for Komorebi. This ensures Komorebi launches automatically upon system login. Optional flags can enable autostart for additional components like whkd, ahk, or komorebi-bar.

```bash
komorebic enable-autostart --config C:\\Users\\user\\.config\\komorebi\\main.json --ffm --whkd --bar
```

--------------------------------

### Enable Komorebi Autostart CLI

Source: https://lgug2z.github.io/komorebi/cli/enable-autostart.html?q=

Use this command to generate the komorebi.lnk shortcut in shell:startup to autostart komorebi. It supports options to enable autostart for whkd, komorebi-bar, and masir.

```bash
Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi

Usage: komorebic.exe enable-autostart [OPTIONS]

Options:
  -c, --config <CONFIG>
          Path to a static configuration JSON file

      --whkd
          Enable autostart of whkd

      --bar
          Enable autostart of komorebi-bar

      --masir
          Enable autostart of masir

  -h, --help
          Print help

```

--------------------------------

### Enable Komorebi Autostart

Source: https://lgug2z.github.io/komorebi/cli/enable-autostart.html

Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi. Use this command to ensure Komorebi launches automatically on system startup.

```bash
komorebic.exe enable-autostart
```

--------------------------------

### Watch Configuration Help

Source: https://lgug2z.github.io/komorebi/cli/watch-configuration.html

Displays help information for the watch-configuration command, including available arguments and options.

```bash
komorebic.exe watch-configuration -h
```

--------------------------------

### Uninstall Komorebi with Scoop

Source: https://lgug2z.github.io/komorebi/installation.html?q=

Use this command to uninstall Komorebi and whkd if you installed them using Scoop.

```bash
scoop uninstall komorebi whkd
```

--------------------------------

### Komorebi Main Configuration with Display Preferences

Source: https://lgug2z.github.io/komorebi/common-workflows/multi-monitor-setup.html?q=

Main Komorebi configuration file demonstrating `display_index_preferences` and `bar_configurations` for multiple monitors.

```json
{
  "display_index_preferences": {
    "0": "MONITOR_1_ID",
    "1": "MONITOR_2_ID",
    "2": "MONITOR_3_ID"
  },
  "bar_configurations": [
    // this bar uses "monitor_index": 0,
    "path/to/bar_config_1.json",
    // this bar uses "monitor_index": 1,
    "path/to/bar_config_2.json",
    // this bar uses "monitor_index": 2,
    "path/to/bar_config_3.json"
  ]
}
```

--------------------------------

### Upgrade Komorebi via Scoop

Source: https://lgug2z.github.io/komorebi/installation.html

Command to upgrade Komorebi when it was initially installed using the Scoop package manager.

```powershell
# for scoop
scoop update komorebi

```

--------------------------------

### Configure Tray and Multi-Window Applications

Source: https://lgug2z.github.io/komorebi/common-workflows/tray-and-multi-window-applications.html

Add rules to the `tray_and_multi_window_applications` configuration to specify how Komorebi should handle applications with tray or multi-window behavior. Use `kind: "Class"` to match by window class.

```json
{
  "tray_and_multi_window_applications": [
    {
      "kind": "Class",
      "id": "SDL_app",
      "matching_strategy": "Equals"
    }
  ]
}

```

--------------------------------

### Upgrade Komorebi via WinGet

Source: https://lgug2z.github.io/komorebi/installation.html

Command to upgrade Komorebi when it was initially installed using the WinGet package manager.

```powershell
# for winget
winget upgrade LGUG2Z.komorebi

```

--------------------------------

### Enable WHKD Autostart

Source: https://lgug2z.github.io/komorebi/cli/enable-autostart.html

Enables the autostart of whkd, a companion application for Komorebi, alongside Komorebi itself. This ensures your hotkeys are available immediately upon login.

```bash
komorebic.exe enable-autostart --whkd
```

--------------------------------

### Print Help for Named Workspace Tiling

Source: https://lgug2z.github.io/komorebi/cli/named-workspace-tiling.html?q=

Displays help information for the `named-workspace-tiling` command, including usage, arguments, and options.

```bash
komorebic.exe named-workspace-tiling -h
```

--------------------------------

### Fetch Application-Specific Configurations

Source: https://lgug2z.github.io/komorebi/example-configurations.html?q=

Use this command to download the latest application-specific configurations for apps that may behave erratically with Komorebi. The output will include a line to paste into your `komorebi.json`.

```bash
komorebic fetch-asc

```

--------------------------------

### Komorebi RightMainVerticalStack Layout

Source: https://lgug2z.github.io/komorebi/example-configurations.html

This layout is suitable for a standard monitor setup, arranging windows in a vertical stack on the right side.

```text
+-----+
|     |
+-----+       |
|     |       |
+-----+-------+

```

--------------------------------

### Kill Background Processes

Source: https://lgug2z.github.io/komorebi/cli/kill.html?q=

This command is used to terminate background processes started by Komorebi. You can specify which processes to kill using flags.

```APIDOC
## Kill Background Processes

### Description

Terminates background processes started by Komorebi.

### Usage

```bash
komorebic.exe kill [OPTIONS]
```

### Options

- `--whkd` - Kill whkd if it is running as a background process.
- `--bar` - Kill komorebi-bar if it is running as a background process.
- `--masir` - Kill masir if it is running as a background process.
- `-h, --help` - Print help information.
```

--------------------------------

### Launch Komorebi GUI Debugging Tool

Source: https://lgug2z.github.io/komorebi/cli/gui.html

Use this command to launch the Komorebi GUI debugging tool. It provides options for help.

```bash
Launch the komorebi-gui debugging tool

Usage: komorebic.exe gui

Options:
  -h, --help
          Print help

```

--------------------------------

### Enable Long Path Support in Windows

Source: https://lgug2z.github.io/komorebi/installation.html

Run this command in an Administrator Terminal before installing Komorebi to enable support for long file paths.

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

```

--------------------------------

### Stack All Windows

Source: https://lgug2z.github.io/komorebi/cli/stack-all.html

Use this command to stack all windows on the focused workspace. It accepts a help flag.

```bash
Stack all windows on the focused workspace

Usage: komorebic.exe stack-all

Options:
  -h, --help
          Print help

```

--------------------------------

### Mouse Follows Focus Help

Source: https://lgug2z.github.io/komorebi/cli/mouse-follows-focus.html

View the help information for the mouse-follows-focus command to understand its arguments and options.

```bash
komorebic.exe mouse-follows-focus --help
```

--------------------------------

### Fetch Application Configuration

Source: https://lgug2z.github.io/komorebi/cli/fetch-app-specific-configuration.html?q=

Use this command to fetch the latest version of applications.json from the komorebi-application-specific-configuration repository. It supports a help flag for more information.

```bash
Fetch the latest version of applications.json from komorebi-application-specific-configuration

Usage: komorebic.exe fetch-app-specific-configuration

Options:
  -h, --help
          Print help

```

--------------------------------

### Show Visible Windows JSON

Source: https://lgug2z.github.io/komorebi/cli/visible-windows.html?q=

Use this command to get a JSON output of all visible windows. This is useful for debugging or integrating with other tools that need window information.

```bash
komorebic.exe visible-windows
```

--------------------------------

### Enable Legacy Configuration Watching

Source: https://lgug2z.github.io/komorebi/cli/watch-configuration.html

Use this command to enable the watching of legacy komorebi.ahk or komorebi.ps1 configurations. This command requires a boolean state argument.

```bash
komorebic.exe watch-configuration enable
```

--------------------------------

### Stop and Start Komorebi Bar

Source: https://lgug2z.github.io/komorebi/troubleshooting.html

Commands to restart the Komorebi Bar. This is often necessary after applying configuration changes, such as adjusting Nvidia Control Panel settings for transparency.

```bash
komorebic stop --bar; komorebic start --bar
```

--------------------------------

### Kill Background Processes with Komorebi CLI

Source: https://lgug2z.github.io/komorebi/cli/kill.html

Use this command to terminate specific background processes started by Komorebi. Options allow targeting 'whkd', 'komorebi-bar', or 'masir'.

```bash
komorebic.exe kill --whkd
komorebic.exe kill --bar
komorebic.exe kill --masir
```

--------------------------------

### Enable Masir Autostart

Source: https://lgug2z.github.io/komorebi/cli/enable-autostart.html

Enables the autostart of masir, likely another component or utility related to Komorebi. Use this to ensure masir is running when you log in.

```bash
komorebic.exe enable-autostart --masir
```

--------------------------------

### Komorebi AutoHotkey v2 Configuration

Source: https://lgug2z.github.io/komorebi/common-workflows/autohotkey.html

This script defines hotkeys for controlling Komorebi. Ensure AutoHotkey v2 is installed. The script assumes `komorebic.exe` is accessible in the system's PATH.

```autohotkey
#Requires AutoHotkey v2.0.2
#SingleInstance Force

Komorebic(cmd) {
    RunWait(format("komorebic.exe %s", cmd), , "Hide")
}

!q::Komorebic("close")
!m::Komorebic("minimize")

; Focus windows
!h::Komorebic("focus left")
!j::Komorebic("focus down")
!k::Komorebic("focus up")
!l::Komorebic("focus right")

!+["::Komorebic("cycle-focus previous")
!+]::Komorebic("cycle-focus next")

; Move windows
!+h::Komorebic("move left")
!+j::Komorebic("move down")
!+k::Komorebic("move up")
!+l::Komorebic("move right")

; Stack windows
!Left::Komorebic("stack left")
!Down::Komorebic("stack down")
!Up::Komorebic("stack up")
!Right::Komorebic("stack right")
!;::Komorebic("unstack")
![::Komorebic("cycle-stack previous")
!]::Komorebic("cycle-stack next")

; Resize
!=::Komorebic("resize-axis horizontal increase")
!-::Komorebic("resize-axis horizontal decrease")
!+=::Komorebic("resize-axis vertical increase")
!+::_::Komorebic("resize-axis vertical decrease")

; Manipulate windows
!t::Komorebic("toggle-float")
!f::Komorebic("toggle-monocle")

; Window manager options
!+r::Komorebic("retile")
!p::Komorebic("toggle-pause")

; Layouts
!x::Komorebic("flip-layout horizontal")
!y::Komorebic("flip-layout vertical")

; Workspaces
!1::Komorebic("focus-workspace 0")
!2::Komorebic("focus-workspace 1")
!3::Komorebic("focus-workspace 2")
!4::Komorebic("focus-workspace 3")
!5::Komorebic("focus-workspace 4")
!6::Komorebic("focus-workspace 5")
!7::Komorebic("focus-workspace 6")
!8::Komorebic("focus-workspace 7")

; Move windows across workspaces
!+1::Komorebic("move-to-workspace 0")
!+2::Komorebic("move-to-workspace 1")
!+3::Komorebic("move-to-workspace 2")
!+4::Komorebic("move-to-workspace 3")
!+5::Komorebic("move-to-workspace 4")
!+6::Komorebic("move-to-workspace 5")
!+7::Komorebic("move-to-workspace 6")
!+8::Komorebic("move-to-workspace 7")

```

--------------------------------

### Komorebi State After Display Sleep

Source: https://lgug2z.github.io/komorebi/troubleshooting.html

Example output of `komorebic state` after the display has woken from sleep, showing `null` for device information. This indicates a potential issue with state persistence.

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

--------------------------------

### Komorebi Internal Monitor Index Map (Default Behavior without Preferences)

Source: https://lgug2z.github.io/komorebi/common-workflows/multi-monitor-setup.html?q=

Demonstrates the default, potentially problematic, monitor index mapping when `display_index_preferences` is not set and a monitor disconnects.

```json
{
  // This is monitor A 
  "0": 0,
  // This is monitor C, because monitor B disconnected. However the bars will think it is monitor B because it has index "1" 
  "1": 1
}
```

--------------------------------

### Session Float Rules Help

Source: https://lgug2z.github.io/komorebi/cli/session-float-rules.html?q=

Displays help information for the session-float-rules command, including available options.

```bash
komorebic.exe session-float-rules --help
```

--------------------------------

### Identify Application with Object Name Change

Source: https://lgug2z.github.io/komorebi/cli/identify-object-name-change-application.html

Use this command to find applications that send the EVENT_OBJECT_NAMECHANGE event when they start. Specify the identifier type (exe, class, title, path) and the corresponding ID.

```bash
komorebic.exe identify-object-name-change-application <IDENTIFIER> <ID>
```

--------------------------------

### Enable Komorebi-Bar Autostart

Source: https://lgug2z.github.io/komorebi/cli/enable-autostart.html

Enables the autostart of komorebi-bar, the status bar component of Komorebi. This ensures the bar is visible and functional on system startup.

```bash
komorebic.exe enable-autostart --bar
```

--------------------------------

### Help for Toggle Workspace Layer

Source: https://lgug2z.github.io/komorebi/cli/toggle-workspace-layer.html?q=

View the help information for the toggle-workspace-layer command to understand available options and usage.

```bash
komorebic.exe toggle-workspace-layer --help
```

--------------------------------

### Focus Workspace by Monitor and Index

Source: https://lgug2z.github.io/komorebi/usage/focusing-workspaces.html

Use `komorebic focus-monitor-workspace` with a monitor index and a workspace index to focus a specific workspace on a specific monitor.

```bash
# example showing how you might bind this command

alt + 1                 : komorebic focus-monitor-workspace 0 0
alt + 2                 : komorebic focus-monitor-workspace 0 1 
alt + 3                 : komorebic focus-monitor-workspace 1 0
```

--------------------------------

### Get Komorebi State Information

Source: https://lgug2z.github.io/komorebi/troubleshooting.html

This command retrieves the current state of Komorebi, including monitor and window information. It's useful for diagnosing issues where Komorebi might lose track of display devices.

```bash
komorebic state
```

--------------------------------

### Focus Workspaces by Index Across Monitors

Source: https://lgug2z.github.io/komorebi/usage/focusing-workspaces.html

Use `komorebic focus-workspaces` with an index to set workspaces on all monitors to that same index, emulating single workspaces spanning all monitors.

```bash
# example showing how you might bind this command

alt + 1                 : komorebic focus-workspaces 0
alt + 2                 : komorebic focus-workspaces 1
alt + 3                 : komorebic focus-workspaces 2
```

--------------------------------

### Configure Display Index Preferences for Multi-Monitor Setups

Source: https://lgug2z.github.io/komorebi/common-workflows/multi-monitor-setup.html?q=

Use `display_index_preferences` to map custom monitor IDs to Komorebi's internal display indices. This is crucial when using the same configuration across different machines with varying monitor arrangements.

```json
{
  "display_index_preferences": {
    "0": "HOME_MONITOR_1_ID",
    "1": "HOME_MONITOR_2_ID",
    "2": "WORK_MONITOR_1_ID",
    "3": "WORK_MONITOR_2_ID"
  },
  "monitors": [
    // HOME_MONITOR_1
    {
      "workspaces": [
        // ...
      ]
    },
    // HOME_MONITOR_2
    {
      "workspaces": [
        // ...
      ]
    },
    // WORK_MONITOR_1
    {
      "workspaces": [
        // ...
      ]
    },
    // WORK_MONITOR_2
    {
      "workspaces": [
        // ...
      ]
    }
  ]
}

```

--------------------------------

### Cycle Stack Options

Source: https://lgug2z.github.io/komorebi/cli/cycle-stack.html?q=

This command supports a help option to display usage information. No other options are available for this specific command.

```bash
komorebic.exe cycle-stack -h
```

--------------------------------

### Configure Multiple Bar Configurations

Source: https://lgug2z.github.io/komorebi/common-workflows/multiple-bar-instances.html?q=

Specify paths to different `komorebi.bar.json` files in the `bar_configurations` array within your `komorebi.json` to run multiple bar instances.

```json
{
  "bar_configurations": [
    "C:/Users/LGUG2Z/komorebi.bar.monitor1.json",
    "C:/Users/LGUG2Z/komorebi.bar.monitor2.json"
  ]
}
```

--------------------------------

### Launch Komorebi GUI Debugging Tool

Source: https://lgug2z.github.io/komorebi/cli/gui.html?q=

Use this command to launch the komorebi-gui debugging tool. This command is useful for diagnosing issues with the Komorebi window manager.

```bash
komorebic.exe gui
```

--------------------------------

### Toggle Komorebi Shortcuts

Source: https://lgug2z.github.io/komorebi/cli/toggle-shortcuts.html

Use this command to toggle the komorebi-shortcuts helper. This command has no options.

```bash
komorebic.exe toggle-shortcuts
```

--------------------------------

### Focus Workspace by Index

Source: https://lgug2z.github.io/komorebi/usage/focusing-workspaces.html

Use `komorebic focus-workspace` with an index to focus a workspace on the current monitor. If the workspace doesn't exist, it and any intermediate workspaces will be created.

```bash
# example showing how you might bind this command

alt + 1                 : komorebic focus-workspace 0
alt + 2                 : komorebic focus-workspace 1
alt + 3                 : komorebic focus-workspace 2
```

--------------------------------

### Focus Workspaces by Index Across All Monitors - Komorebi

Source: https://lgug2z.github.io/komorebi/usage/focusing-workspaces.html?q=

Set workspaces on all monitors to the same index, emulating single workspaces that span across all monitors.

```bash
alt + 1                 : komorebic focus-workspaces 0
alt + 2                 : komorebic focus-workspaces 1
alt + 3                 : komorebic focus-workspaces 2
```

--------------------------------

### Show All Session Float Rules

Source: https://lgug2z.github.io/komorebi/cli/session-float-rules.html?q=

Use this command to display all current session float rules configured in Komorebi. No arguments are needed.

```bash
komorebic.exe session-float-rules
```

--------------------------------

### Add Initial Workspace Rule

Source: https://lgug2z.github.io/komorebi/cli/initial-workspace-rule.html?q=

Associates an application with a workspace on a monitor for its first appearance.

```APIDOC
## komorebic.exe initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>

### Description
Add a rule to associate an application with a workspace on first show.

### Method
CLI Command

### Arguments
#### Arguments
- **IDENTIFIER** (string) - Required - Specifies the type of identifier for the application. Possible values: exe, class, title, path.
- **ID** (string) - Required - The identifier string for the application (e.g., application executable name, window class, window title, or file path).
- **MONITOR** (integer) - Required - The index of the monitor (zero-indexed) where the workspace is located.
- **WORKSPACE** (integer) - Required - The index of the workspace on the specified monitor (zero-indexed).

### Options
#### Options
- **-h, --help** - Prints help information for the command.
```

--------------------------------

### Configure Dynamic Layout Rules

Source: https://lgug2z.github.io/komorebi/common-workflows/dynamic-layout-switching.html

Define layout rules within the Komorebi configuration file. Specify the number of window containers and the desired layout (e.g., BSP or a custom layout path).

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

```

--------------------------------

### Complete Configuration Command

Source: https://lgug2z.github.io/komorebi/cli/complete-configuration.html?q=

This command is used to signal that the final configuration option has been sent for legacy komorebi.ahk or komorebi.ps1 configurations.

```APIDOC
## complete-configuration

### Description
Signals that the final configuration option has been sent for legacy komorebi.ahk or komorebi.ps1 configurations.

### Usage
`komorebic.exe complete-configuration`

### Options
- `-h, --help`
  Print help
```

--------------------------------

### Fetch Application Configuration

Source: https://lgug2z.github.io/komorebi/cli/fetch-app-specific-configuration.html

Fetches the latest version of applications.json from the komorebi-application-specific-configuration repository.

```APIDOC
## fetch-app-specific-configuration

### Description
Fetches the latest version of applications.json from the komorebi-application-specific-configuration repository.

### Usage
`komorebic.exe fetch-app-specific-configuration`

### Options
- `-h, --help`
  Print help
```

--------------------------------

### Eagerly Focus Window by Exe

Source: https://lgug2z.github.io/komorebi/usage/focusing-windows.html?q=

Bind keys to attempt to focus the first window matching a specified executable name on any workspace.

```shell
win + 1                 : komorebic eager-focus firefox.exe
```

--------------------------------

### Check Komorebi Configuration

Source: https://lgug2z.github.io/komorebi/cli/check.html

Use this command to check your Komorebi configuration file for common errors. Specify the path to your static configuration JSON file using the --komorebi-config option.

```bash
komorebic.exe check --komorebi-config path/to/your/config.json
```

--------------------------------

### Komorebi CLI Kill Command Usage

Source: https://lgug2z.github.io/komorebi/cli/kill.html

Displays help information for the 'kill' command, outlining available options for terminating background processes.

```bash
komorebic.exe kill --help
```

--------------------------------

### Show Komorebi Configuration Path

Source: https://lgug2z.github.io/komorebi/cli/configuration.html

Use this command to display the absolute path to the komorebi.json configuration file. This is useful for locating and editing your Komorebi settings.

```bash
komorebic.exe configuration
```

--------------------------------

### Komorebi Window Manager Configuration (komorebi.json)

Source: https://lgug2z.github.io/komorebi/example-configurations.html?q=

This JSON file defines the main Komorebi window manager settings, including workspace padding, border styles, themes, and monitor configurations with predefined workspaces and layouts.

```json
{
  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.39/schema.json",
  "app_specific_configuration_path": "$Env:USERPROFILE/applications.json",
  "window_hiding_behaviour": "Cloak",
  "cross_monitor_move_behaviour": "Insert",
  "default_workspace_padding": 20,
  "default_container_padding": 20,
  "border": true,
  "border_width": 8,
  "border_offset": -1,
  "theme": {
    "palette": "Base16",
    "name": "Ashes",
    "unfocused_border": "Base03",
    "bar_accent": "Base0D"
  },
  "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"
        }
      ]
    }
  ]
}

```

--------------------------------

### Enable Workspace Tiling

Source: https://lgug2z.github.io/komorebi/cli/named-workspace-tiling.html?q=

Use this command to enable window tiling for a specific workspace. Replace `<WORKSPACE>` with the name of the target workspace.

```bash
komorebic.exe named-workspace-tiling <WORKSPACE> enable
```

--------------------------------

### Set KOMOREBI_CONFIG_HOME in PowerShell Profile

Source: https://lgug2z.github.io/komorebi/common-workflows/komorebi-config-home.html

Use these commands to create the custom directory, open your PowerShell profile, add the environment variable setting, and reload the profile. Ensure you replace 'LGUG2Z' with your actual login username.

```powershell
# 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

# 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

```

--------------------------------

### Cycle to Next Empty Workspace

Source: https://lgug2z.github.io/komorebi/cli/cycle-empty-workspace.html

Use this command to focus the next available empty workspace. Specify 'next' as the cycle direction.

```bash
komorebic.exe cycle-empty-workspace next
```

--------------------------------

### Stack All Windows Command

Source: https://lgug2z.github.io/komorebi/cli/stack-all.html?q=

Use this command to stack all windows on the focused workspace. It takes no arguments.

```bash
komorebic.exe stack-all
```

--------------------------------

### Display Help for Komorebi Kill Command

Source: https://lgug2z.github.io/komorebi/cli/kill.html?q=

View help information for the komorebic kill command to understand available options and usage.

```bash
komorebic.exe kill -h
```

--------------------------------

### Show Komorebi Data Directory

Source: https://lgug2z.github.io/komorebi/cli/data-directory.html?q=

Use this command to display the path to Komorebi's data directory, which is typically located in %LOCALAPPDATA%.

```bash
komorebic.exe data-directory
```

--------------------------------

### Enable Window Animations

Source: https://lgug2z.github.io/komorebi/common-workflows/animations.html?q=

Define animation options in the `komorebi.json` configuration file to enable window movement animations. You can set a custom duration in milliseconds, a custom easing style, and a custom frames per second value. Higher FPS and longer durations may increase CPU usage. This feature is experimental and may cause visual artifacts.

```json
{
  "animation": {
    "enabled": true,
    "duration": 250,
    "fps": 60,
    "style": "EaseOutSine"
  }
}
```

--------------------------------

### Promote Window Command Usage

Source: https://lgug2z.github.io/komorebi/cli/promote-window.html?q=

Use this command to promote a window in a specific direction. The direction can be left, right, up, or down.

```bash
komorebic.exe promote-window <OPERATION_DIRECTION>
```

--------------------------------

### whkdrc Configuration for Komorebi

Source: https://lgug2z.github.io/komorebi/example-configurations.html

This configuration file defines hotkeys for Komorebi window management using whkd. It includes commands for reloading configuration, toggling shortcuts, closing, minimizing, focusing, moving, stacking, resizing, and manipulating windows, as well as layout and workspace switching.

```ini
.shell powershell

# Reload whkd configuration
# alt + o                 : taskkill /f /im whkd.exe && start /b whkd # if shell is cmd
alt + o                 : taskkill /f /im whkd.exe; Start-Process whkd -WindowStyle hidden # if shell is pwsh / powershell
alt + shift + o         : komorebic reload-configuration

alt + i                 : komorebic toggle-shortcuts

# 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 + q                 : komorebic close
alt + m                 : komorebic minimize

# Focus windows
alt + h                 : komorebic focus left
alt + j                 : komorebic focus down
alt + k                 : komorebic focus up
alt + l                 : komorebic focus right
alt + shift + oem_4     : komorebic cycle-focus previous # oem_4 is [
alt + shift + oem_6     : komorebic cycle-focus next # oem_6 is ]

# Move windows
alt + shift + h         : komorebic move left
alt + shift + j         : komorebic move down
alt + shift + k         : komorebic move up
alt + shift + l         : komorebic move right
alt + shift + return    : komorebic promote

# Stack windows
alt + left              : komorebic stack left
alt + down              : komorebic stack down
alt + up                : komorebic stack up
alt + right             : komorebic stack right
alt + oem_1             : komorebic unstack # oem_1 is ;
alt + oem_4             : komorebic cycle-stack previous # oem_4 is [
alt + oem_6             : komorebic cycle-stack next # oem_6 is ]

# Resize
alt + oem_plus          : komorebic resize-axis horizontal increase
alt + oem_minus         : komorebic resize-axis horizontal decrease
alt + shift + oem_plus  : komorebic resize-axis vertical increase
alt + shift + oem_minus : komorebic resize-axis vertical decrease

# Manipulate windows
alt + t                 : komorebic toggle-float
alt + shift + f         : komorebic toggle-monocle

# Window manager options
alt + shift + r         : komorebic retile
alt + p                 : komorebic toggle-pause

# Layouts
alt + x                 : komorebic flip-layout horizontal
alt + y                 : komorebic flip-layout vertical

# Workspaces
alt + 1                 : komorebic focus-workspace 0
alt + 2                 : komorebic focus-workspace 1
alt + 3                 : komorebic focus-workspace 2
alt + 4                 : komorebic focus-workspace 3
alt + 5                 : komorebic focus-workspace 4
alt + 6                 : komorebic focus-workspace 5
alt + 7                 : komorebic focus-workspace 6
alt + 8                 : komorebic focus-workspace 7

```

--------------------------------

### Komorebi Internal Monitor Index Map (Initial)

Source: https://lgug2z.github.io/komorebi/common-workflows/multi-monitor-setup.html?q=

Illustrates the initial internal map Komorebi creates for monitor indices when all monitors are connected.

```json
{
  // This is monitor A
  "0": 0,
  // This is monitor B
  "1": 1,
  // This is monitor C
  "2": 2
}
```

--------------------------------

### Configure Floating Applications in Komorebi

Source: https://lgug2z.github.io/komorebi/common-workflows/floating-applications.html?q=

Add application rules to the `floating_applications` array in your `komorebi.json` file to make them float. Use `Title` kind with `Equals` matching strategy for exact title matches.

```json
{
  "floating_applications": [
    {
      "kind": "Title",
      "id": "Media Player",
      "matching_strategy": "Equals"
    }
  ]
}
```

--------------------------------

### Promote Focus Command

Source: https://lgug2z.github.io/komorebi/cli/promote-focus.html?q=

Use this command to promote the currently focused window to the top of the tree. This command has no options.

```bash
Promote the user focus to the top of the tree

Usage: komorebic.exe promote-focus

Options:
  -h, --help
          Print help

```
Tokens:
Raw