diff --git a/docs/cli/adjust-container-padding.md b/docs/cli/adjust-container-padding.md new file mode 100644 index 00000000..f96f1929 --- /dev/null +++ b/docs/cli/adjust-container-padding.md @@ -0,0 +1,19 @@ +# adjust-container-padding + +``` +Adjust container padding on the focused workspace + +Usage: komorebic adjust-container-padding + +Arguments: + + [possible values: increase, decrease] + + + Pixels to adjust by as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/adjust-workspace-padding.md b/docs/cli/adjust-workspace-padding.md new file mode 100644 index 00000000..5045aa95 --- /dev/null +++ b/docs/cli/adjust-workspace-padding.md @@ -0,0 +1,19 @@ +# adjust-workspace-padding + +``` +Adjust workspace padding on the focused workspace + +Usage: komorebic adjust-workspace-padding + +Arguments: + + [possible values: increase, decrease] + + + Pixels to adjust by as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/application-specific-configuration-schema.md b/docs/cli/application-specific-configuration-schema.md new file mode 100644 index 00000000..642b6bb8 --- /dev/null +++ b/docs/cli/application-specific-configuration-schema.md @@ -0,0 +1,12 @@ +# application-specific-configuration-schema + +``` +Generate a JSON Schema for applications.json + +Usage: komorebic application-specific-configuration-schema + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/change-layout.md b/docs/cli/change-layout.md new file mode 100644 index 00000000..5124942b --- /dev/null +++ b/docs/cli/change-layout.md @@ -0,0 +1,16 @@ +# change-layout + +``` +Set the layout on the focused workspace + +Usage: komorebic change-layout + +Arguments: + + [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/clear-all-workspace-rules.md b/docs/cli/clear-all-workspace-rules.md new file mode 100644 index 00000000..630b1b32 --- /dev/null +++ b/docs/cli/clear-all-workspace-rules.md @@ -0,0 +1,12 @@ +# clear-all-workspace-rules + +``` +Remove all application association rules for all workspaces + +Usage: komorebic clear-all-workspace-rules + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/clear-named-workspace-layout-rules.md b/docs/cli/clear-named-workspace-layout-rules.md new file mode 100644 index 00000000..9c515266 --- /dev/null +++ b/docs/cli/clear-named-workspace-layout-rules.md @@ -0,0 +1,16 @@ +# clear-named-workspace-layout-rules + +``` +Clear all dynamic layout rules for the specified workspace + +Usage: komorebic clear-named-workspace-layout-rules + +Arguments: + + Target workspace name + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/clear-named-workspace-rules.md b/docs/cli/clear-named-workspace-rules.md new file mode 100644 index 00000000..4e60cdef --- /dev/null +++ b/docs/cli/clear-named-workspace-rules.md @@ -0,0 +1,16 @@ +# clear-named-workspace-rules + +``` +Remove all application association rules for a named workspace + +Usage: komorebic clear-named-workspace-rules + +Arguments: + + Name of a workspace + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/clear-session-float-rules.md b/docs/cli/clear-session-float-rules.md new file mode 100644 index 00000000..99d6b036 --- /dev/null +++ b/docs/cli/clear-session-float-rules.md @@ -0,0 +1,12 @@ +# clear-session-float-rules + +``` +Clear all session float rules + +Usage: komorebic clear-session-float-rules + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/clear-workspace-layout-rules.md b/docs/cli/clear-workspace-layout-rules.md new file mode 100644 index 00000000..f3256d45 --- /dev/null +++ b/docs/cli/clear-workspace-layout-rules.md @@ -0,0 +1,19 @@ +# clear-workspace-layout-rules + +``` +Clear all dynamic layout rules for the specified workspace + +Usage: komorebic clear-workspace-layout-rules + +Arguments: + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/clear-workspace-rules.md b/docs/cli/clear-workspace-rules.md new file mode 100644 index 00000000..7be02e78 --- /dev/null +++ b/docs/cli/clear-workspace-rules.md @@ -0,0 +1,19 @@ +# clear-workspace-rules + +``` +Remove all application association rules for a workspace by monitor and workspace index + +Usage: komorebic clear-workspace-rules + +Arguments: + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/close-workspace.md b/docs/cli/close-workspace.md new file mode 100644 index 00000000..860171f9 --- /dev/null +++ b/docs/cli/close-workspace.md @@ -0,0 +1,12 @@ +# close-workspace + +``` +Close the focused workspace (must be empty and unnamed) + +Usage: komorebic close-workspace + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/close.md b/docs/cli/close.md new file mode 100644 index 00000000..8577f0b9 --- /dev/null +++ b/docs/cli/close.md @@ -0,0 +1,12 @@ +# close + +``` +Close the focused window + +Usage: komorebic close + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md new file mode 100644 index 00000000..d7d1b3b0 --- /dev/null +++ b/docs/cli/configuration.md @@ -0,0 +1,12 @@ +# configuration + +``` +Show the path to komorebi.json + +Usage: komorebic configuration + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/container-padding.md b/docs/cli/container-padding.md new file mode 100644 index 00000000..2096bb43 --- /dev/null +++ b/docs/cli/container-padding.md @@ -0,0 +1,22 @@ +# container-padding + +``` +Set the container padding for the specified workspace + +Usage: komorebic container-padding + +Arguments: + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + + + Pixels to pad with as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cross-monitor-move-behaviour.md b/docs/cli/cross-monitor-move-behaviour.md new file mode 100644 index 00000000..719ad4ee --- /dev/null +++ b/docs/cli/cross-monitor-move-behaviour.md @@ -0,0 +1,19 @@ +# cross-monitor-move-behaviour + +``` +Set the behaviour when moving windows across monitor boundaries + +Usage: komorebic cross-monitor-move-behaviour + +Arguments: + + Possible values: + - swap: Swap the window container with the window container at the edge of the adjacent monitor + - insert: Insert the window container into the focused workspace on the adjacent monitor + - no-op: Do nothing if trying to move a window container in the direction of an adjacent monitor + +Options: + -h, --help + Print help (see a summary with '-h') + +``` \ No newline at end of file diff --git a/docs/cli/cycle-empty-workspace.md b/docs/cli/cycle-empty-workspace.md new file mode 100644 index 00000000..029f07d9 --- /dev/null +++ b/docs/cli/cycle-empty-workspace.md @@ -0,0 +1,16 @@ +# cycle-empty-workspace + +``` +Focus the next empty workspace in the given cycle direction (if one exists) + +Usage: komorebic cycle-empty-workspace + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-focus.md b/docs/cli/cycle-focus.md new file mode 100644 index 00000000..c39f188d --- /dev/null +++ b/docs/cli/cycle-focus.md @@ -0,0 +1,16 @@ +# cycle-focus + +``` +Change focus to the window in the specified cycle direction + +Usage: komorebic cycle-focus + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-layout.md b/docs/cli/cycle-layout.md new file mode 100644 index 00000000..e41330ea --- /dev/null +++ b/docs/cli/cycle-layout.md @@ -0,0 +1,16 @@ +# cycle-layout + +``` +Cycle between available layouts + +Usage: komorebic cycle-layout + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-monitor.md b/docs/cli/cycle-monitor.md new file mode 100644 index 00000000..1c080ee0 --- /dev/null +++ b/docs/cli/cycle-monitor.md @@ -0,0 +1,16 @@ +# cycle-monitor + +``` +Focus the monitor in the given cycle direction + +Usage: komorebic cycle-monitor + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-move-to-monitor.md b/docs/cli/cycle-move-to-monitor.md new file mode 100644 index 00000000..c77da7d0 --- /dev/null +++ b/docs/cli/cycle-move-to-monitor.md @@ -0,0 +1,16 @@ +# cycle-move-to-monitor + +``` +Move the focused window to the monitor in the given cycle direction + +Usage: komorebic cycle-move-to-monitor + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-move-to-workspace.md b/docs/cli/cycle-move-to-workspace.md new file mode 100644 index 00000000..80fcc85c --- /dev/null +++ b/docs/cli/cycle-move-to-workspace.md @@ -0,0 +1,16 @@ +# cycle-move-to-workspace + +``` +Move the focused window to the workspace in the given cycle direction + +Usage: komorebic cycle-move-to-workspace + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-move-workspace-to-monitor.md b/docs/cli/cycle-move-workspace-to-monitor.md new file mode 100644 index 00000000..c3ceec2d --- /dev/null +++ b/docs/cli/cycle-move-workspace-to-monitor.md @@ -0,0 +1,16 @@ +# cycle-move-workspace-to-monitor + +``` +Move the focused workspace monitor in the given cycle direction + +Usage: komorebic cycle-move-workspace-to-monitor + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-move.md b/docs/cli/cycle-move.md new file mode 100644 index 00000000..a35abbad --- /dev/null +++ b/docs/cli/cycle-move.md @@ -0,0 +1,16 @@ +# cycle-move + +``` +Move the focused window in the specified cycle direction + +Usage: komorebic cycle-move + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-send-to-monitor.md b/docs/cli/cycle-send-to-monitor.md new file mode 100644 index 00000000..230ea770 --- /dev/null +++ b/docs/cli/cycle-send-to-monitor.md @@ -0,0 +1,16 @@ +# cycle-send-to-monitor + +``` +Send the focused window to the monitor in the given cycle direction + +Usage: komorebic cycle-send-to-monitor + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-send-to-workspace.md b/docs/cli/cycle-send-to-workspace.md new file mode 100644 index 00000000..9226db68 --- /dev/null +++ b/docs/cli/cycle-send-to-workspace.md @@ -0,0 +1,16 @@ +# cycle-send-to-workspace + +``` +Send the focused window to the workspace in the given cycle direction + +Usage: komorebic cycle-send-to-workspace + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-stack-index.md b/docs/cli/cycle-stack-index.md new file mode 100644 index 00000000..0f16a20a --- /dev/null +++ b/docs/cli/cycle-stack-index.md @@ -0,0 +1,16 @@ +# cycle-stack-index + +``` +Cycle the index of the focused window in the focused stack in the specified cycle direction + +Usage: komorebic cycle-stack-index + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-stack.md b/docs/cli/cycle-stack.md new file mode 100644 index 00000000..d3e40e08 --- /dev/null +++ b/docs/cli/cycle-stack.md @@ -0,0 +1,16 @@ +# cycle-stack + +``` +Cycle the focused stack in the specified cycle direction + +Usage: komorebic cycle-stack + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/cycle-workspace.md b/docs/cli/cycle-workspace.md new file mode 100644 index 00000000..be617167 --- /dev/null +++ b/docs/cli/cycle-workspace.md @@ -0,0 +1,16 @@ +# cycle-workspace + +``` +Focus the workspace in the given cycle direction + +Usage: komorebic cycle-workspace + +Arguments: + + [possible values: previous, next] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/data-directory.md b/docs/cli/data-directory.md new file mode 100644 index 00000000..fc9d9336 --- /dev/null +++ b/docs/cli/data-directory.md @@ -0,0 +1,12 @@ +# data-directory + +``` +Show the path to komorebi's data directory in %LOCALAPPDATA% + +Usage: komorebic data-directory + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/display-index-preference.md b/docs/cli/display-index-preference.md new file mode 100644 index 00000000..3acdfc41 --- /dev/null +++ b/docs/cli/display-index-preference.md @@ -0,0 +1,19 @@ +# display-index-preference + +``` +Set the display index preference for a monitor identified using its display name + +Usage: komorebic display-index-preference + +Arguments: + + Preferred monitor index (zero-indexed) + + + Display name as identified in komorebic state + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/eager-focus.md b/docs/cli/eager-focus.md new file mode 100644 index 00000000..271a0ac5 --- /dev/null +++ b/docs/cli/eager-focus.md @@ -0,0 +1,16 @@ +# eager-focus + +``` +Focus the first managed window matching the given exe + +Usage: komorebic eager-focus + +Arguments: + + Case-sensitive exe identifier + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/enforce-workspace-rules.md b/docs/cli/enforce-workspace-rules.md new file mode 100644 index 00000000..546aa1a7 --- /dev/null +++ b/docs/cli/enforce-workspace-rules.md @@ -0,0 +1,12 @@ +# enforce-workspace-rules + +``` +Enforce all workspace rules, including initial workspace rules that have already been applied + +Usage: komorebic enforce-workspace-rules + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/ensure-named-workspaces.md b/docs/cli/ensure-named-workspaces.md new file mode 100644 index 00000000..68663c31 --- /dev/null +++ b/docs/cli/ensure-named-workspaces.md @@ -0,0 +1,19 @@ +# ensure-named-workspaces + +``` +Create these many named workspaces for the specified monitor + +Usage: komorebic ensure-named-workspaces [NAMES]... + +Arguments: + + Monitor index (zero-indexed) + + [NAMES]... + Names of desired workspaces + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/ensure-workspaces.md b/docs/cli/ensure-workspaces.md new file mode 100644 index 00000000..12ea285b --- /dev/null +++ b/docs/cli/ensure-workspaces.md @@ -0,0 +1,19 @@ +# ensure-workspaces + +``` +Create at least this many workspaces for the specified monitor + +Usage: komorebic ensure-workspaces + +Arguments: + + Monitor index (zero-indexed) + + + Number of desired workspaces + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/fetch-app-specific-configuration.md b/docs/cli/fetch-app-specific-configuration.md new file mode 100644 index 00000000..e8f49f41 --- /dev/null +++ b/docs/cli/fetch-app-specific-configuration.md @@ -0,0 +1,12 @@ +# fetch-app-specific-configuration + +``` +Fetch the latest version of applications.json from komorebi-application-specific-configuration + +Usage: komorebic fetch-app-specific-configuration + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/flip-layout.md b/docs/cli/flip-layout.md new file mode 100644 index 00000000..463e2648 --- /dev/null +++ b/docs/cli/flip-layout.md @@ -0,0 +1,16 @@ +# flip-layout + +``` +Flip the layout on the focused workspace + +Usage: komorebic flip-layout + +Arguments: + + [possible values: horizontal, vertical, horizontal-and-vertical] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focus-last-workspace.md b/docs/cli/focus-last-workspace.md new file mode 100644 index 00000000..8af3ee2c --- /dev/null +++ b/docs/cli/focus-last-workspace.md @@ -0,0 +1,12 @@ +# focus-last-workspace + +``` +Focus the last focused workspace on the focused monitor + +Usage: komorebic focus-last-workspace + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focus-monitor-at-cursor.md b/docs/cli/focus-monitor-at-cursor.md new file mode 100644 index 00000000..5320c7f6 --- /dev/null +++ b/docs/cli/focus-monitor-at-cursor.md @@ -0,0 +1,12 @@ +# focus-monitor-at-cursor + +``` +Focus the monitor at the current cursor location + +Usage: komorebic focus-monitor-at-cursor + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focus-monitor-workspace.md b/docs/cli/focus-monitor-workspace.md new file mode 100644 index 00000000..648eb855 --- /dev/null +++ b/docs/cli/focus-monitor-workspace.md @@ -0,0 +1,19 @@ +# focus-monitor-workspace + +``` +Focus the specified workspace on the target monitor + +Usage: komorebic focus-monitor-workspace + +Arguments: + + Target monitor index (zero-indexed) + + + Workspace index on the target monitor (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focus-monitor.md b/docs/cli/focus-monitor.md new file mode 100644 index 00000000..f97ff091 --- /dev/null +++ b/docs/cli/focus-monitor.md @@ -0,0 +1,16 @@ +# focus-monitor + +``` +Focus the specified monitor + +Usage: komorebic focus-monitor + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focus-named-workspace.md b/docs/cli/focus-named-workspace.md new file mode 100644 index 00000000..431a8191 --- /dev/null +++ b/docs/cli/focus-named-workspace.md @@ -0,0 +1,16 @@ +# focus-named-workspace + +``` +Focus the specified workspace + +Usage: komorebic focus-named-workspace + +Arguments: + + Target workspace name + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focus-stack-window.md b/docs/cli/focus-stack-window.md new file mode 100644 index 00000000..1cb84a37 --- /dev/null +++ b/docs/cli/focus-stack-window.md @@ -0,0 +1,16 @@ +# focus-stack-window + +``` +Focus the specified window index in the focused stack + +Usage: komorebic focus-stack-window + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focus-workspace.md b/docs/cli/focus-workspace.md new file mode 100644 index 00000000..6ad82870 --- /dev/null +++ b/docs/cli/focus-workspace.md @@ -0,0 +1,16 @@ +# focus-workspace + +``` +Focus the specified workspace on the focused monitor + +Usage: komorebic focus-workspace + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focus-workspaces.md b/docs/cli/focus-workspaces.md new file mode 100644 index 00000000..e7efee3f --- /dev/null +++ b/docs/cli/focus-workspaces.md @@ -0,0 +1,16 @@ +# focus-workspaces + +``` +Focus the specified workspace on all monitors + +Usage: komorebic focus-workspaces + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focus.md b/docs/cli/focus.md new file mode 100644 index 00000000..1a33b5a0 --- /dev/null +++ b/docs/cli/focus.md @@ -0,0 +1,16 @@ +# focus + +``` +Change focus to the window in the specified direction + +Usage: komorebic focus + +Arguments: + + [possible values: left, right, up, down] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focused-workspace-container-padding.md b/docs/cli/focused-workspace-container-padding.md new file mode 100644 index 00000000..88855c4d --- /dev/null +++ b/docs/cli/focused-workspace-container-padding.md @@ -0,0 +1,16 @@ +# focused-workspace-container-padding + +``` +Set container padding on the focused workspace + +Usage: komorebic focused-workspace-container-padding + +Arguments: + + Pixels size to set as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/focused-workspace-padding.md b/docs/cli/focused-workspace-padding.md new file mode 100644 index 00000000..1ea8bf16 --- /dev/null +++ b/docs/cli/focused-workspace-padding.md @@ -0,0 +1,16 @@ +# focused-workspace-padding + +``` +Set workspace padding on the focused workspace + +Usage: komorebic focused-workspace-padding + +Arguments: + + Pixels size to set as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/generate-static-config.md b/docs/cli/generate-static-config.md new file mode 100644 index 00000000..b4b906ea --- /dev/null +++ b/docs/cli/generate-static-config.md @@ -0,0 +1,12 @@ +# generate-static-config + +``` +Generates a static configuration JSON file based on the current window manager state + +Usage: komorebic generate-static-config + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/global-state.md b/docs/cli/global-state.md new file mode 100644 index 00000000..0ee6ef95 --- /dev/null +++ b/docs/cli/global-state.md @@ -0,0 +1,12 @@ +# global-state + +``` +Show a JSON representation of the current global state + +Usage: komorebic global-state + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/global-work-area-offset.md b/docs/cli/global-work-area-offset.md new file mode 100644 index 00000000..e7ae7153 --- /dev/null +++ b/docs/cli/global-work-area-offset.md @@ -0,0 +1,25 @@ +# global-work-area-offset + +``` +Set offsets to exclude parts of the work area from tiling + +Usage: komorebic global-work-area-offset + +Arguments: + + Size of the left work area offset (set right to left * 2 to maintain right padding) + + + Size of the top work area offset (set bottom to the same value to maintain bottom padding) + + + Size of the right work area offset + + + Size of the bottom work area offset + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/ignore-rule.md b/docs/cli/ignore-rule.md new file mode 100644 index 00000000..55ff1047 --- /dev/null +++ b/docs/cli/ignore-rule.md @@ -0,0 +1,19 @@ +# ignore-rule + +``` +Add a rule to ignore the specified application + +Usage: komorebic ignore-rule + +Arguments: + + [possible values: exe, class, title, path] + + + Identifier as a string + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/initial-named-workspace-rule.md b/docs/cli/initial-named-workspace-rule.md new file mode 100644 index 00000000..430cb561 --- /dev/null +++ b/docs/cli/initial-named-workspace-rule.md @@ -0,0 +1,22 @@ +# initial-named-workspace-rule + +``` +Add a rule to associate an application with a named workspace on first show + +Usage: komorebic initial-named-workspace-rule + +Arguments: + + [possible values: exe, class, title, path] + + + Identifier as a string + + + Name of a workspace + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/initial-workspace-rule.md b/docs/cli/initial-workspace-rule.md new file mode 100644 index 00000000..9e588517 --- /dev/null +++ b/docs/cli/initial-workspace-rule.md @@ -0,0 +1,25 @@ +# initial-workspace-rule + +``` +Add a rule to associate an application with a workspace on first show + +Usage: komorebic initial-workspace-rule + +Arguments: + + [possible values: exe, class, title, path] + + + Identifier as a string + + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/load-resize.md b/docs/cli/load-resize.md new file mode 100644 index 00000000..c133a805 --- /dev/null +++ b/docs/cli/load-resize.md @@ -0,0 +1,16 @@ +# load-resize + +``` +Load the resize layout dimensions from a file + +Usage: komorebic load-resize + +Arguments: + + File from which the resize layout dimensions should be loaded + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/log.md b/docs/cli/log.md new file mode 100644 index 00000000..522aa763 --- /dev/null +++ b/docs/cli/log.md @@ -0,0 +1,12 @@ +# log + +``` +Tail komorebi.exe's process logs (cancel with Ctrl-C) + +Usage: komorebic log + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/manage-rule.md b/docs/cli/manage-rule.md new file mode 100644 index 00000000..11fe3dfa --- /dev/null +++ b/docs/cli/manage-rule.md @@ -0,0 +1,19 @@ +# manage-rule + +``` +Add a rule to always manage the specified application + +Usage: komorebic manage-rule + +Arguments: + + [possible values: exe, class, title, path] + + + Identifier as a string + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/manage.md b/docs/cli/manage.md new file mode 100644 index 00000000..8da10472 --- /dev/null +++ b/docs/cli/manage.md @@ -0,0 +1,12 @@ +# manage + +``` +Force komorebi to manage the focused window + +Usage: komorebic manage + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/minimize.md b/docs/cli/minimize.md new file mode 100644 index 00000000..c814942d --- /dev/null +++ b/docs/cli/minimize.md @@ -0,0 +1,12 @@ +# minimize + +``` +Minimize the focused window + +Usage: komorebic minimize + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/monitor-information.md b/docs/cli/monitor-information.md new file mode 100644 index 00000000..a6b14e70 --- /dev/null +++ b/docs/cli/monitor-information.md @@ -0,0 +1,12 @@ +# monitor-information + +``` +Show information about connected monitors + +Usage: komorebic monitor-information + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/monitor-work-area-offset.md b/docs/cli/monitor-work-area-offset.md new file mode 100644 index 00000000..2a42bff2 --- /dev/null +++ b/docs/cli/monitor-work-area-offset.md @@ -0,0 +1,28 @@ +# monitor-work-area-offset + +``` +Set offsets for a monitor to exclude parts of the work area from tiling + +Usage: komorebic monitor-work-area-offset + +Arguments: + + Monitor index (zero-indexed) + + + Size of the left work area offset (set right to left * 2 to maintain right padding) + + + Size of the top work area offset (set bottom to the same value to maintain bottom padding) + + + Size of the right work area offset + + + Size of the bottom work area offset + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/mouse-follows-focus.md b/docs/cli/mouse-follows-focus.md new file mode 100644 index 00000000..9a38b687 --- /dev/null +++ b/docs/cli/mouse-follows-focus.md @@ -0,0 +1,16 @@ +# mouse-follows-focus + +``` +Enable or disable mouse follows focus on all workspaces + +Usage: komorebic mouse-follows-focus + +Arguments: + + [possible values: enable, disable] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/move-to-last-workspace.md b/docs/cli/move-to-last-workspace.md new file mode 100644 index 00000000..16a08c4c --- /dev/null +++ b/docs/cli/move-to-last-workspace.md @@ -0,0 +1,12 @@ +# move-to-last-workspace + +``` +Move the focused window to the last focused monitor workspace + +Usage: komorebic move-to-last-workspace + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/move-to-monitor-workspace.md b/docs/cli/move-to-monitor-workspace.md new file mode 100644 index 00000000..09217a9a --- /dev/null +++ b/docs/cli/move-to-monitor-workspace.md @@ -0,0 +1,19 @@ +# move-to-monitor-workspace + +``` +Move the focused window to the specified monitor workspace + +Usage: komorebic move-to-monitor-workspace + +Arguments: + + Target monitor index (zero-indexed) + + + Workspace index on the target monitor (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/move-to-monitor.md b/docs/cli/move-to-monitor.md new file mode 100644 index 00000000..1febf73f --- /dev/null +++ b/docs/cli/move-to-monitor.md @@ -0,0 +1,16 @@ +# move-to-monitor + +``` +Move the focused window to the specified monitor + +Usage: komorebic move-to-monitor + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/move-to-named-workspace.md b/docs/cli/move-to-named-workspace.md new file mode 100644 index 00000000..f97635c5 --- /dev/null +++ b/docs/cli/move-to-named-workspace.md @@ -0,0 +1,16 @@ +# move-to-named-workspace + +``` +Move the focused window to the specified workspace + +Usage: komorebic move-to-named-workspace + +Arguments: + + Target workspace name + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/move-to-workspace.md b/docs/cli/move-to-workspace.md new file mode 100644 index 00000000..12ee6670 --- /dev/null +++ b/docs/cli/move-to-workspace.md @@ -0,0 +1,16 @@ +# move-to-workspace + +``` +Move the focused window to the specified workspace + +Usage: komorebic move-to-workspace + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/move-workspace-to-monitor.md b/docs/cli/move-workspace-to-monitor.md new file mode 100644 index 00000000..69a02874 --- /dev/null +++ b/docs/cli/move-workspace-to-monitor.md @@ -0,0 +1,16 @@ +# move-workspace-to-monitor + +``` +Move the focused workspace to the specified monitor + +Usage: komorebic move-workspace-to-monitor + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/move.md b/docs/cli/move.md new file mode 100644 index 00000000..913701bc --- /dev/null +++ b/docs/cli/move.md @@ -0,0 +1,16 @@ +# move + +``` +Move the focused window in the specified direction + +Usage: komorebic move + +Arguments: + + [possible values: left, right, up, down] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/named-workspace-container-padding.md b/docs/cli/named-workspace-container-padding.md new file mode 100644 index 00000000..8432c8a8 --- /dev/null +++ b/docs/cli/named-workspace-container-padding.md @@ -0,0 +1,19 @@ +# named-workspace-container-padding + +``` +Set the container padding for the specified workspace + +Usage: komorebic named-workspace-container-padding + +Arguments: + + Target workspace name + + + Pixels to pad with as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/named-workspace-layout-rule.md b/docs/cli/named-workspace-layout-rule.md new file mode 100644 index 00000000..4e37e06a --- /dev/null +++ b/docs/cli/named-workspace-layout-rule.md @@ -0,0 +1,22 @@ +# named-workspace-layout-rule + +``` +Add a dynamic layout rule for the specified workspace + +Usage: komorebic named-workspace-layout-rule + +Arguments: + + Target workspace name + + + The number of window containers on-screen required to trigger this layout rule + + + [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/named-workspace-layout.md b/docs/cli/named-workspace-layout.md new file mode 100644 index 00000000..15095e7e --- /dev/null +++ b/docs/cli/named-workspace-layout.md @@ -0,0 +1,19 @@ +# named-workspace-layout + +``` +Set the layout for the specified workspace + +Usage: komorebic named-workspace-layout + +Arguments: + + Target workspace name + + + [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/named-workspace-padding.md b/docs/cli/named-workspace-padding.md new file mode 100644 index 00000000..35182bc4 --- /dev/null +++ b/docs/cli/named-workspace-padding.md @@ -0,0 +1,19 @@ +# named-workspace-padding + +``` +Set the workspace padding for the specified workspace + +Usage: komorebic named-workspace-padding + +Arguments: + + Target workspace name + + + Pixels to pad with as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/named-workspace-rule.md b/docs/cli/named-workspace-rule.md new file mode 100644 index 00000000..72e11eea --- /dev/null +++ b/docs/cli/named-workspace-rule.md @@ -0,0 +1,22 @@ +# named-workspace-rule + +``` +Add a rule to associate an application with a named workspace + +Usage: komorebic named-workspace-rule + +Arguments: + + [possible values: exe, class, title, path] + + + Identifier as a string + + + Name of a workspace + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/named-workspace-tiling.md b/docs/cli/named-workspace-tiling.md new file mode 100644 index 00000000..9dfb2b4a --- /dev/null +++ b/docs/cli/named-workspace-tiling.md @@ -0,0 +1,19 @@ +# named-workspace-tiling + +``` +Enable or disable window tiling for the specified workspace + +Usage: komorebic named-workspace-tiling + +Arguments: + + Target workspace name + + + [possible values: enable, disable] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/new-workspace.md b/docs/cli/new-workspace.md new file mode 100644 index 00000000..166dfa8b --- /dev/null +++ b/docs/cli/new-workspace.md @@ -0,0 +1,12 @@ +# new-workspace + +``` +Create and append a new workspace on the focused monitor + +Usage: komorebic new-workspace + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/notification-schema.md b/docs/cli/notification-schema.md new file mode 100644 index 00000000..ea480035 --- /dev/null +++ b/docs/cli/notification-schema.md @@ -0,0 +1,12 @@ +# notification-schema + +``` +Generate a JSON Schema of subscription notifications + +Usage: komorebic notification-schema + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/promote-focus.md b/docs/cli/promote-focus.md new file mode 100644 index 00000000..dcbd198d --- /dev/null +++ b/docs/cli/promote-focus.md @@ -0,0 +1,12 @@ +# promote-focus + +``` +Promote the user focus to the top of the tree + +Usage: komorebic promote-focus + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/promote-window.md b/docs/cli/promote-window.md new file mode 100644 index 00000000..e59e293b --- /dev/null +++ b/docs/cli/promote-window.md @@ -0,0 +1,16 @@ +# promote-window + +``` +Promote the window in the specified direction + +Usage: komorebic promote-window + +Arguments: + + [possible values: left, right, up, down] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/promote.md b/docs/cli/promote.md new file mode 100644 index 00000000..ddf40bde --- /dev/null +++ b/docs/cli/promote.md @@ -0,0 +1,12 @@ +# promote + +``` +Promote the focused window to the top of the tree + +Usage: komorebic promote + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/query.md b/docs/cli/query.md new file mode 100644 index 00000000..5b8b4bb8 --- /dev/null +++ b/docs/cli/query.md @@ -0,0 +1,16 @@ +# query + +``` +Query the current window manager state + +Usage: komorebic query + +Arguments: + + [possible values: focused-monitor-index, focused-workspace-index, focused-container-index, focused-window-index, focused-workspace-name, focused-workspace-layout, focused-container-kind, version] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/quick-load-resize.md b/docs/cli/quick-load-resize.md new file mode 100644 index 00000000..11ead3af --- /dev/null +++ b/docs/cli/quick-load-resize.md @@ -0,0 +1,12 @@ +# quick-load-resize + +``` +Load the last quicksaved resize layout dimensions + +Usage: komorebic quick-load-resize + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/quick-save-resize.md b/docs/cli/quick-save-resize.md new file mode 100644 index 00000000..d9ba4d7c --- /dev/null +++ b/docs/cli/quick-save-resize.md @@ -0,0 +1,12 @@ +# quick-save-resize + +``` +Quicksave the current resize layout dimensions + +Usage: komorebic quick-save-resize + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/replace-configuration.md b/docs/cli/replace-configuration.md new file mode 100644 index 00000000..4ebad87d --- /dev/null +++ b/docs/cli/replace-configuration.md @@ -0,0 +1,16 @@ +# replace-configuration + +``` +Replace the configuration of a running instance of komorebi from a static configuration file + +Usage: komorebic replace-configuration + +Arguments: + + Static configuration JSON file from which the configuration should be loaded + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/resize-axis.md b/docs/cli/resize-axis.md new file mode 100644 index 00000000..a3757729 --- /dev/null +++ b/docs/cli/resize-axis.md @@ -0,0 +1,19 @@ +# resize-axis + +``` +Resize the focused window or primary column along the specified axis + +Usage: komorebic resize-axis + +Arguments: + + [possible values: horizontal, vertical, horizontal-and-vertical] + + + [possible values: increase, decrease] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/resize-delta.md b/docs/cli/resize-delta.md new file mode 100644 index 00000000..cb91eb48 --- /dev/null +++ b/docs/cli/resize-delta.md @@ -0,0 +1,16 @@ +# resize-delta + +``` +Set the resize delta (used by resize-edge and resize-axis) + +Usage: komorebic resize-delta + +Arguments: + + The delta of pixels by which to increase or decrease window dimensions when resizing + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/resize-edge.md b/docs/cli/resize-edge.md new file mode 100644 index 00000000..4819d819 --- /dev/null +++ b/docs/cli/resize-edge.md @@ -0,0 +1,19 @@ +# resize-edge + +``` +Resize the focused window in the specified direction + +Usage: komorebic resize-edge + +Arguments: + + [possible values: left, right, up, down] + + + [possible values: increase, decrease] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/retile.md b/docs/cli/retile.md new file mode 100644 index 00000000..2336b013 --- /dev/null +++ b/docs/cli/retile.md @@ -0,0 +1,12 @@ +# retile + +``` +Force the retiling of all managed windows + +Usage: komorebic retile + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/save-resize.md b/docs/cli/save-resize.md new file mode 100644 index 00000000..8eb1918c --- /dev/null +++ b/docs/cli/save-resize.md @@ -0,0 +1,16 @@ +# save-resize + +``` +Save the current resize layout dimensions to a file + +Usage: komorebic save-resize + +Arguments: + + File to which the resize layout dimensions should be saved + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/scrolling-layout-columns.md b/docs/cli/scrolling-layout-columns.md new file mode 100644 index 00000000..d417c279 --- /dev/null +++ b/docs/cli/scrolling-layout-columns.md @@ -0,0 +1,16 @@ +# scrolling-layout-columns + +``` +Set the number of visible columns for the Scrolling layout on the focused workspace + +Usage: komorebic scrolling-layout-columns + +Arguments: + + Desired number of visible columns + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/send-to-last-workspace.md b/docs/cli/send-to-last-workspace.md new file mode 100644 index 00000000..65c43c62 --- /dev/null +++ b/docs/cli/send-to-last-workspace.md @@ -0,0 +1,12 @@ +# send-to-last-workspace + +``` +Send the focused window to the last focused monitor workspace + +Usage: komorebic send-to-last-workspace + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/send-to-monitor-workspace.md b/docs/cli/send-to-monitor-workspace.md new file mode 100644 index 00000000..6cd22746 --- /dev/null +++ b/docs/cli/send-to-monitor-workspace.md @@ -0,0 +1,19 @@ +# send-to-monitor-workspace + +``` +Send the focused window to the specified monitor workspace + +Usage: komorebic send-to-monitor-workspace + +Arguments: + + Target monitor index (zero-indexed) + + + Workspace index on the target monitor (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/send-to-monitor.md b/docs/cli/send-to-monitor.md new file mode 100644 index 00000000..adb6ab90 --- /dev/null +++ b/docs/cli/send-to-monitor.md @@ -0,0 +1,16 @@ +# send-to-monitor + +``` +Send the focused window to the specified monitor + +Usage: komorebic send-to-monitor + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/send-to-named-workspace.md b/docs/cli/send-to-named-workspace.md new file mode 100644 index 00000000..b824ff52 --- /dev/null +++ b/docs/cli/send-to-named-workspace.md @@ -0,0 +1,16 @@ +# send-to-named-workspace + +``` +Send the focused window to the specified workspace + +Usage: komorebic send-to-named-workspace + +Arguments: + + Target workspace name + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/send-to-workspace.md b/docs/cli/send-to-workspace.md new file mode 100644 index 00000000..3d69d1d7 --- /dev/null +++ b/docs/cli/send-to-workspace.md @@ -0,0 +1,16 @@ +# send-to-workspace + +``` +Send the focused window to the specified workspace + +Usage: komorebic send-to-workspace + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/session-float-rule.md b/docs/cli/session-float-rule.md new file mode 100644 index 00000000..5161f45e --- /dev/null +++ b/docs/cli/session-float-rule.md @@ -0,0 +1,12 @@ +# session-float-rule + +``` +Add a rule to float the foreground window for the rest of this session + +Usage: komorebic session-float-rule + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/session-float-rules.md b/docs/cli/session-float-rules.md new file mode 100644 index 00000000..65f8251f --- /dev/null +++ b/docs/cli/session-float-rules.md @@ -0,0 +1,12 @@ +# session-float-rules + +``` +Show all session float rules + +Usage: komorebic session-float-rules + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/socket-schema.md b/docs/cli/socket-schema.md new file mode 100644 index 00000000..5712e391 --- /dev/null +++ b/docs/cli/socket-schema.md @@ -0,0 +1,12 @@ +# socket-schema + +``` +Generate a JSON Schema of socket messages + +Usage: komorebic socket-schema + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/stack-all.md b/docs/cli/stack-all.md new file mode 100644 index 00000000..adfb58ef --- /dev/null +++ b/docs/cli/stack-all.md @@ -0,0 +1,12 @@ +# stack-all + +``` +Stack all windows on the focused workspace + +Usage: komorebic stack-all + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/stack.md b/docs/cli/stack.md new file mode 100644 index 00000000..b1fc6626 --- /dev/null +++ b/docs/cli/stack.md @@ -0,0 +1,16 @@ +# stack + +``` +Stack the focused window in the specified direction + +Usage: komorebic stack + +Arguments: + + [possible values: left, right, up, down] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/start.md b/docs/cli/start.md new file mode 100644 index 00000000..28714e45 --- /dev/null +++ b/docs/cli/start.md @@ -0,0 +1,15 @@ +# start + +``` +Start komorebi.exe as a background process + +Usage: komorebic start [OPTIONS] + +Options: + -c, --config + Path to a static configuration JSON file + + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/state.md b/docs/cli/state.md new file mode 100644 index 00000000..fd6ec1d2 --- /dev/null +++ b/docs/cli/state.md @@ -0,0 +1,12 @@ +# state + +``` +Show a JSON representation of the current window manager state + +Usage: komorebic state + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/static-config-schema.md b/docs/cli/static-config-schema.md new file mode 100644 index 00000000..d44c4e0e --- /dev/null +++ b/docs/cli/static-config-schema.md @@ -0,0 +1,12 @@ +# static-config-schema + +``` +Generate a JSON Schema of the static configuration file + +Usage: komorebic static-config-schema + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/stop.md b/docs/cli/stop.md new file mode 100644 index 00000000..e35f982c --- /dev/null +++ b/docs/cli/stop.md @@ -0,0 +1,12 @@ +# stop + +``` +Stop the komorebi.exe process and restore all hidden windows + +Usage: komorebic stop + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/subscribe-socket.md b/docs/cli/subscribe-socket.md new file mode 100644 index 00000000..96a70068 --- /dev/null +++ b/docs/cli/subscribe-socket.md @@ -0,0 +1,16 @@ +# subscribe-socket + +``` +Subscribe to komorebi events using a Unix Domain Socket + +Usage: komorebic subscribe-socket + +Arguments: + + Name of the socket to send event notifications to + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/swap-workspaces-with-monitor.md b/docs/cli/swap-workspaces-with-monitor.md new file mode 100644 index 00000000..cf84aac6 --- /dev/null +++ b/docs/cli/swap-workspaces-with-monitor.md @@ -0,0 +1,16 @@ +# swap-workspaces-with-monitor + +``` +Swap focused monitor workspaces with specified monitor + +Usage: komorebic swap-workspaces-with-monitor + +Arguments: + + Target index (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-cross-monitor-move-behaviour.md b/docs/cli/toggle-cross-monitor-move-behaviour.md new file mode 100644 index 00000000..237a7173 --- /dev/null +++ b/docs/cli/toggle-cross-monitor-move-behaviour.md @@ -0,0 +1,12 @@ +# toggle-cross-monitor-move-behaviour + +``` +Toggle the behaviour when moving windows across monitor boundaries + +Usage: komorebic toggle-cross-monitor-move-behaviour + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-float-override.md b/docs/cli/toggle-float-override.md new file mode 100644 index 00000000..203dc53f --- /dev/null +++ b/docs/cli/toggle-float-override.md @@ -0,0 +1,12 @@ +# toggle-float-override + +``` +Enable or disable float override, which makes it so every new window opens in floating mode + +Usage: komorebic toggle-float-override + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-float.md b/docs/cli/toggle-float.md new file mode 100644 index 00000000..15ceab84 --- /dev/null +++ b/docs/cli/toggle-float.md @@ -0,0 +1,12 @@ +# toggle-float + +``` +Toggle floating mode for the focused window + +Usage: komorebic toggle-float + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-lock.md b/docs/cli/toggle-lock.md new file mode 100644 index 00000000..d7165d51 --- /dev/null +++ b/docs/cli/toggle-lock.md @@ -0,0 +1,12 @@ +# toggle-lock + +``` +Toggle a lock for the focused container, ensuring it will not be displaced by any new windows + +Usage: komorebic toggle-lock + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-monocle.md b/docs/cli/toggle-monocle.md new file mode 100644 index 00000000..1b3f8af7 --- /dev/null +++ b/docs/cli/toggle-monocle.md @@ -0,0 +1,12 @@ +# toggle-monocle + +``` +Toggle monocle mode for the focused container + +Usage: komorebic toggle-monocle + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-mouse-follows-focus.md b/docs/cli/toggle-mouse-follows-focus.md new file mode 100644 index 00000000..58cdf6a0 --- /dev/null +++ b/docs/cli/toggle-mouse-follows-focus.md @@ -0,0 +1,12 @@ +# toggle-mouse-follows-focus + +``` +Toggle mouse follows focus on all workspaces + +Usage: komorebic toggle-mouse-follows-focus + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-pause.md b/docs/cli/toggle-pause.md new file mode 100644 index 00000000..55618219 --- /dev/null +++ b/docs/cli/toggle-pause.md @@ -0,0 +1,12 @@ +# toggle-pause + +``` +Toggle the paused state for all window tiling + +Usage: komorebic toggle-pause + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-tiling.md b/docs/cli/toggle-tiling.md new file mode 100644 index 00000000..e029bfc8 --- /dev/null +++ b/docs/cli/toggle-tiling.md @@ -0,0 +1,12 @@ +# toggle-tiling + +``` +Toggle window tiling on the focused workspace + +Usage: komorebic toggle-tiling + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-window-based-work-area-offset.md b/docs/cli/toggle-window-based-work-area-offset.md new file mode 100644 index 00000000..426896cd --- /dev/null +++ b/docs/cli/toggle-window-based-work-area-offset.md @@ -0,0 +1,12 @@ +# toggle-window-based-work-area-offset + +``` +Toggle application of the window-based work area offset for the focused workspace + +Usage: komorebic toggle-window-based-work-area-offset + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-window-container-behaviour.md b/docs/cli/toggle-window-container-behaviour.md new file mode 100644 index 00000000..449e1197 --- /dev/null +++ b/docs/cli/toggle-window-container-behaviour.md @@ -0,0 +1,12 @@ +# toggle-window-container-behaviour + +``` +Toggle the behaviour for new windows (stacking or dynamic tiling) + +Usage: komorebic toggle-window-container-behaviour + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-workspace-float-override.md b/docs/cli/toggle-workspace-float-override.md new file mode 100644 index 00000000..497630a9 --- /dev/null +++ b/docs/cli/toggle-workspace-float-override.md @@ -0,0 +1,13 @@ +# toggle-workspace-float-override + +``` +Enable or disable float override, which makes it so every new window opens in floating mode, for the currently focused workspace. If there was no override value set for the workspace previously it takes the opposite of the +global value + +Usage: komorebic toggle-workspace-float-override + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-workspace-layer.md b/docs/cli/toggle-workspace-layer.md new file mode 100644 index 00000000..fca30422 --- /dev/null +++ b/docs/cli/toggle-workspace-layer.md @@ -0,0 +1,12 @@ +# toggle-workspace-layer + +``` +Toggle between the Tiling and Floating layers on the focused workspace + +Usage: komorebic toggle-workspace-layer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/toggle-workspace-window-container-behaviour.md b/docs/cli/toggle-workspace-window-container-behaviour.md new file mode 100644 index 00000000..df02d57c --- /dev/null +++ b/docs/cli/toggle-workspace-window-container-behaviour.md @@ -0,0 +1,12 @@ +# toggle-workspace-window-container-behaviour + +``` +Toggle the behaviour for new windows (stacking or dynamic tiling) for currently focused workspace. If there was no behaviour set for the workspace previously it takes the opposite of the global value + +Usage: komorebic toggle-workspace-window-container-behaviour + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/unmanage.md b/docs/cli/unmanage.md new file mode 100644 index 00000000..e76f89a0 --- /dev/null +++ b/docs/cli/unmanage.md @@ -0,0 +1,12 @@ +# unmanage + +``` +Unmanage a window that was forcibly managed + +Usage: komorebic unmanage + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/unmanaged-window-operation-behaviour.md b/docs/cli/unmanaged-window-operation-behaviour.md new file mode 100644 index 00000000..1afefb4c --- /dev/null +++ b/docs/cli/unmanaged-window-operation-behaviour.md @@ -0,0 +1,18 @@ +# unmanaged-window-operation-behaviour + +``` +Set the operation behaviour when the focused window is not managed + +Usage: komorebic unmanaged-window-operation-behaviour + +Arguments: + + Possible values: + - op: Process komorebic commands on temporarily unmanaged/floated windows + - no-op: Ignore komorebic commands on temporarily unmanaged/floated windows + +Options: + -h, --help + Print help (see a summary with '-h') + +``` \ No newline at end of file diff --git a/docs/cli/unstack-all.md b/docs/cli/unstack-all.md new file mode 100644 index 00000000..ea74a184 --- /dev/null +++ b/docs/cli/unstack-all.md @@ -0,0 +1,12 @@ +# unstack-all + +``` +Unstack all windows in the focused container + +Usage: komorebic unstack-all + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/unstack.md b/docs/cli/unstack.md new file mode 100644 index 00000000..7175fb46 --- /dev/null +++ b/docs/cli/unstack.md @@ -0,0 +1,12 @@ +# unstack + +``` +Unstack the focused window + +Usage: komorebic unstack + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/unsubscribe-socket.md b/docs/cli/unsubscribe-socket.md new file mode 100644 index 00000000..ba0e983e --- /dev/null +++ b/docs/cli/unsubscribe-socket.md @@ -0,0 +1,16 @@ +# unsubscribe-socket + +``` +Unsubscribe from komorebi events + +Usage: komorebic unsubscribe-socket + +Arguments: + + Name of the socket to stop sending event notifications to + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/visible-windows.md b/docs/cli/visible-windows.md new file mode 100644 index 00000000..f8fdbf5d --- /dev/null +++ b/docs/cli/visible-windows.md @@ -0,0 +1,12 @@ +# visible-windows + +``` +Show a JSON representation of visible windows + +Usage: komorebic visible-windows + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/workspace-layout-rule.md b/docs/cli/workspace-layout-rule.md new file mode 100644 index 00000000..b7294e0c --- /dev/null +++ b/docs/cli/workspace-layout-rule.md @@ -0,0 +1,25 @@ +# workspace-layout-rule + +``` +Add a dynamic layout rule for the specified workspace + +Usage: komorebic workspace-layout-rule + +Arguments: + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + + + The number of window containers on-screen required to trigger this layout rule + + + [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/workspace-layout.md b/docs/cli/workspace-layout.md new file mode 100644 index 00000000..62bf3c1f --- /dev/null +++ b/docs/cli/workspace-layout.md @@ -0,0 +1,22 @@ +# workspace-layout + +``` +Set the layout for the specified workspace + +Usage: komorebic workspace-layout + +Arguments: + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + + + [possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/workspace-name.md b/docs/cli/workspace-name.md new file mode 100644 index 00000000..bc0ed92f --- /dev/null +++ b/docs/cli/workspace-name.md @@ -0,0 +1,22 @@ +# workspace-name + +``` +Set the workspace name for the specified workspace + +Usage: komorebic workspace-name + +Arguments: + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + + + Name of the workspace as a String + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/workspace-padding.md b/docs/cli/workspace-padding.md new file mode 100644 index 00000000..dfe6e475 --- /dev/null +++ b/docs/cli/workspace-padding.md @@ -0,0 +1,22 @@ +# workspace-padding + +``` +Set the workspace padding for the specified workspace + +Usage: komorebic workspace-padding + +Arguments: + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + + + Pixels to pad with as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/workspace-rule.md b/docs/cli/workspace-rule.md new file mode 100644 index 00000000..ed8c97e5 --- /dev/null +++ b/docs/cli/workspace-rule.md @@ -0,0 +1,25 @@ +# workspace-rule + +``` +Add a rule to associate an application with a workspace + +Usage: komorebic workspace-rule + +Arguments: + + [possible values: exe, class, title, path] + + + Identifier as a string + + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/workspace-tiling.md b/docs/cli/workspace-tiling.md new file mode 100644 index 00000000..fbb62efc --- /dev/null +++ b/docs/cli/workspace-tiling.md @@ -0,0 +1,22 @@ +# workspace-tiling + +``` +Enable or disable window tiling for the specified workspace + +Usage: komorebic workspace-tiling + +Arguments: + + Monitor index (zero-indexed) + + + Workspace index on the specified monitor (zero-indexed) + + + [possible values: enable, disable] + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/docs/cli/workspace-work-area-offset.md b/docs/cli/workspace-work-area-offset.md new file mode 100644 index 00000000..0fe448db --- /dev/null +++ b/docs/cli/workspace-work-area-offset.md @@ -0,0 +1,31 @@ +# workspace-work-area-offset + +``` +Set offsets for a workspace to exclude parts of the work area from tiling + +Usage: komorebic workspace-work-area-offset + +Arguments: + + Monitor index (zero-indexed) + + + Workspace index (zero-indexed) + + + Size of the left work area offset (set right to left * 2 to maintain right padding) + + + Size of the top work area offset (set bottom to the same value to maintain bottom padding) + + + Size of the right work area offset + + + Size of the bottom work area offset + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/schema.asc.json b/schema.asc.json new file mode 100644 index 00000000..d39fec39 --- /dev/null +++ b/schema.asc.json @@ -0,0 +1,168 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "ApplicationSpecificConfiguration", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AscApplicationRulesOrSchema" + }, + "definitions": { + "ApplicationIdentifier": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "AscApplicationRules": { + "description": "Rules that determine how an application is handled", + "type": "object", + "properties": { + "floating": { + "description": "Rules to manage specific windows as floating windows", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/MatchingRule" + } + }, + "ignore": { + "description": "Rules to ignore specific windows", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/MatchingRule" + } + }, + "layered": { + "description": "Rules to identify applications which have the `WS_EX_LAYERED` Extended Window Style", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/MatchingRule" + } + }, + "manage": { + "description": "Rules to forcibly manage specific windows", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/MatchingRule" + } + }, + "object_name_change": { + "description": "Rules to identify applications which send the `EVENT_OBJECT_NAMECHANGE` event on launch", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/MatchingRule" + } + }, + "slow_application": { + "description": "Rules to identify applications which are slow to send initial event notifications", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/MatchingRule" + } + }, + "transparency_ignore": { + "description": "Rules to ignore specific windows from the transparency feature", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/MatchingRule" + } + }, + "tray_and_multi_window": { + "description": "Rules to identify applications which minimize to the tray or have multiple windows", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/MatchingRule" + } + } + } + }, + "AscApplicationRulesOrSchema": { + "anyOf": [ + { + "$ref": "#/definitions/AscApplicationRules" + }, + { + "type": "string" + } + ] + }, + "IdWithIdentifier": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "$ref": "#/definitions/ApplicationIdentifier" + }, + "matching_strategy": { + "anyOf": [ + { + "$ref": "#/definitions/MatchingStrategy" + }, + { + "type": "null" + } + ] + } + } + }, + "MatchingRule": { + "anyOf": [ + { + "$ref": "#/definitions/IdWithIdentifier" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/IdWithIdentifier" + } + } + ] + }, + "MatchingStrategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } +} diff --git a/schema.json b/schema.json new file mode 100644 index 00000000..953fcb04 --- /dev/null +++ b/schema.json @@ -0,0 +1,1384 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "StaticConfig", + "description": "The `komorebi.json` static configuration file reference for `v0.1.39`", + "type": "object", + "properties": { + "app_specific_configuration_path": { + "description": "Path to applications.json from komorebi-application-specific-configurations (default: None)", + "anyOf": [ + { + "description": "A single applications.json file", + "type": "string" + }, + { + "description": "Multiple applications.json files", + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "border_overflow_applications": { + "description": "Identify border overflow applications", + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + } + } + ] + } + }, + "cross_boundary_behaviour": { + "description": "Determine what happens when an action is called on a window at a monitor boundary (default: Monitor)", + "oneOf": [ + { + "description": "Attempt to perform actions across a workspace boundary", + "type": "string", + "enum": [ + "Workspace" + ] + }, + { + "description": "Attempt to perform actions across a monitor boundary", + "type": "string", + "enum": [ + "Monitor" + ] + } + ] + }, + "cross_monitor_move_behaviour": { + "description": "Determine what happens when a window is moved across a monitor boundary (default: Swap)", + "oneOf": [ + { + "description": "Swap the window container with the window container at the edge of the adjacent monitor", + "type": "string", + "enum": [ + "Swap" + ] + }, + { + "description": "Insert the window container into the focused workspace on the adjacent monitor", + "type": "string", + "enum": [ + "Insert" + ] + }, + { + "description": "Do nothing if trying to move a window container in the direction of an adjacent monitor", + "type": "string", + "enum": [ + "NoOp" + ] + } + ] + }, + "default_container_padding": { + "description": "Global default container padding (default: 10)", + "type": "integer", + "format": "int32" + }, + "default_workspace_padding": { + "description": "Add transparency to unfocused windows (default: false) Global default workspace padding (default: 10)", + "type": "integer", + "format": "int32" + }, + "display_index_preferences": { + "description": "Set display index preferences", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "float_override": { + "description": "Enable or disable float override, which makes it so every new window opens in floating mode (default: false)", + "type": "boolean" + }, + "float_override_placement": { + "description": "Determines the `Placement` to be used when spawning a window with float override active (default: None)", + "oneOf": [ + { + "description": "Does not change the size or position of the window", + "type": "string", + "enum": [ + "None" + ] + }, + { + "description": "Center the window without changing the size", + "type": "string", + "enum": [ + "Center" + ] + }, + { + "description": "Center the window and resize it according to the `AspectRatio`", + "type": "string", + "enum": [ + "CenterAndResize" + ] + } + ] + }, + "float_rule_placement": { + "description": "Determines the `Placement` to be used when spawning a window that matches a 'floating_applications' rule (default: None)", + "oneOf": [ + { + "description": "Does not change the size or position of the window", + "type": "string", + "enum": [ + "None" + ] + }, + { + "description": "Center the window without changing the size", + "type": "string", + "enum": [ + "Center" + ] + }, + { + "description": "Center the window and resize it according to the `AspectRatio`", + "type": "string", + "enum": [ + "CenterAndResize" + ] + } + ] + }, + "floating_applications": { + "description": "Identify applications which should be managed as floating windows", + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + } + } + ] + } + }, + "floating_layer_behaviour": { + "description": "Determines what happens on a new window when on the `FloatingLayer` (default: Tile)", + "oneOf": [ + { + "description": "Tile new windows (unless they match a float rule or float override is active)", + "type": "string", + "enum": [ + "Tile" + ] + }, + { + "description": "Float new windows", + "type": "string", + "enum": [ + "Float" + ] + } + ] + }, + "floating_layer_placement": { + "description": "Determines the `Placement` to be used when spawning a window on the floating layer with the `FloatingLayerBehaviour` set to `FloatingLayerBehaviour::Float` (default: Center)", + "oneOf": [ + { + "description": "Does not change the size or position of the window", + "type": "string", + "enum": [ + "None" + ] + }, + { + "description": "Center the window without changing the size", + "type": "string", + "enum": [ + "Center" + ] + }, + { + "description": "Center the window and resize it according to the `AspectRatio`", + "type": "string", + "enum": [ + "CenterAndResize" + ] + } + ] + }, + "floating_window_aspect_ratio": { + "description": "Identify applications which are slow to send initial event notifications Aspect ratio to resize with when toggling floating mode for a window", + "anyOf": [ + { + "description": "A predefined aspect ratio", + "oneOf": [ + { + "description": "21:9", + "type": "string", + "enum": [ + "Ultrawide" + ] + }, + { + "description": "16:9", + "type": "string", + "enum": [ + "Widescreen" + ] + }, + { + "description": "4:3", + "type": "string", + "enum": [ + "Standard" + ] + } + ] + }, + { + "description": "A custom W:H aspect ratio", + "type": "array", + "items": [ + { + "type": "integer", + "format": "int32" + }, + { + "type": "integer", + "format": "int32" + } + ], + "maxItems": 2, + "minItems": 2 + } + ] + }, + "global_work_area_offset": { + "description": "Global work area (space used for tiling) offset (default: None)", + "type": "object", + "required": [ + "bottom", + "left", + "right", + "top" + ], + "properties": { + "bottom": { + "type": "integer", + "format": "int32" + }, + "left": { + "type": "integer", + "format": "int32" + }, + "right": { + "type": "integer", + "format": "int32" + }, + "top": { + "type": "integer", + "format": "int32" + } + } + }, + "ignore_rules": { + "description": "Individual window floating rules", + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + } + } + ] + } + }, + "layered_applications": { + "description": "Identify applications that have the WS_EX_LAYERED extended window style", + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + } + } + ] + } + }, + "manage_rules": { + "description": "Individual window force-manage rules", + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + } + } + ] + } + }, + "monitors": { + "description": "Monitor and workspace configurations", + "type": "array", + "items": { + "type": "object", + "required": [ + "workspaces" + ], + "properties": { + "container_padding": { + "description": "Container padding (default: global)", + "type": "integer", + "format": "int32" + }, + "floating_layer_behaviour": { + "description": "Determine what happens to a new window when the Floating workspace layer is active (default: Tile)", + "oneOf": [ + { + "description": "Tile new windows (unless they match a float rule or float override is active)", + "type": "string", + "enum": [ + "Tile" + ] + }, + { + "description": "Float new windows", + "type": "string", + "enum": [ + "Float" + ] + } + ] + }, + "window_based_work_area_offset": { + "description": "Window based work area offset (default: None)", + "type": "object", + "required": [ + "bottom", + "left", + "right", + "top" + ], + "properties": { + "bottom": { + "type": "integer", + "format": "int32" + }, + "left": { + "type": "integer", + "format": "int32" + }, + "right": { + "type": "integer", + "format": "int32" + }, + "top": { + "type": "integer", + "format": "int32" + } + } + }, + "window_based_work_area_offset_limit": { + "description": "Open window limit after which the window based work area offset will no longer be applied (default: 1)", + "type": "integer", + "format": "int" + }, + "work_area_offset": { + "description": "Monitor-specific work area offset (default: None)", + "type": "object", + "required": [ + "bottom", + "left", + "right", + "top" + ], + "properties": { + "bottom": { + "type": "integer", + "format": "int32" + }, + "left": { + "type": "integer", + "format": "int32" + }, + "right": { + "type": "integer", + "format": "int32" + }, + "top": { + "type": "integer", + "format": "int32" + } + } + }, + "workspace_padding": { + "description": "Workspace padding (default: global)", + "type": "integer", + "format": "int32" + }, + "workspaces": { + "description": "Workspace configurations", + "type": "array", + "items": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "apply_window_based_work_area_offset": { + "description": "Apply this monitor's window-based work area offset (default: true)", + "type": "boolean" + }, + "container_padding": { + "description": "Container padding (default: global)", + "type": "integer", + "format": "int32" + }, + "custom_layout": { + "description": "END OF LIFE FEATURE: Custom Layout (default: None)", + "type": "string" + }, + "float_override": { + "description": "Enable or disable float override, which makes it so every new window opens in floating mode (default: false)", + "type": "boolean" + }, + "floating_layer_behaviour": { + "description": "Determine what happens to a new window when the Floating workspace layer is active (default: Tile)", + "oneOf": [ + { + "description": "Tile new windows (unless they match a float rule or float override is active)", + "type": "string", + "enum": [ + "Tile" + ] + }, + { + "description": "Float new windows", + "type": "string", + "enum": [ + "Float" + ] + } + ] + }, + "initial_workspace_rules": { + "description": "Initial workspace application rules", + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + } + } + ] + } + }, + "layout": { + "description": "Layout (default: BSP)", + "type": "string", + "enum": [ + "BSP", + "Columns", + "Rows", + "VerticalStack", + "HorizontalStack", + "UltrawideVerticalStack", + "Grid", + "RightMainVerticalStack", + "Scrolling" + ] + }, + "layout_flip": { + "description": "Specify an axis on which to flip the selected layout (default: None)", + "type": "string", + "enum": [ + "Horizontal", + "Vertical", + "HorizontalAndVertical" + ] + }, + "layout_options": { + "description": "Layout-specific options (default: None)", + "type": "object", + "properties": { + "scrolling": { + "description": "Options related to the Scrolling layout", + "type": "object", + "required": [ + "columns" + ], + "properties": { + "columns": { + "description": "Desired number of visible columns (default: 3)", + "type": "integer", + "format": "uint", + "minimum": 0.0 + } + } + } + } + }, + "layout_rules": { + "description": "Layout rules in the format of threshold => layout (default: None)", + "type": "object", + "additionalProperties": { + "type": "string", + "enum": [ + "BSP", + "Columns", + "Rows", + "VerticalStack", + "HorizontalStack", + "UltrawideVerticalStack", + "Grid", + "RightMainVerticalStack", + "Scrolling" + ] + } + }, + "name": { + "description": "Name", + "type": "string" + }, + "tile": { + "description": "Enable or disable tiling for the workspace (default: true)", + "type": "boolean" + }, + "window_container_behaviour": { + "description": "Determine what happens when a new window is opened (default: Create)", + "oneOf": [ + { + "description": "Create a new container for each new window", + "type": "string", + "enum": [ + "Create" + ] + }, + { + "description": "Append new windows to the focused window container", + "type": "string", + "enum": [ + "Append" + ] + } + ] + }, + "window_container_behaviour_rules": { + "description": "Window container behaviour rules in the format of threshold => behaviour (default: None)", + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "description": "Create a new container for each new window", + "type": "string", + "enum": [ + "Create" + ] + }, + { + "description": "Append new windows to the focused window container", + "type": "string", + "enum": [ + "Append" + ] + } + ] + } + }, + "work_area_offset": { + "description": "Workspace specific work area offset (default: None)", + "type": "object", + "required": [ + "bottom", + "left", + "right", + "top" + ], + "properties": { + "bottom": { + "type": "integer", + "format": "int32" + }, + "left": { + "type": "integer", + "format": "int32" + }, + "right": { + "type": "integer", + "format": "int32" + }, + "top": { + "type": "integer", + "format": "int32" + } + } + }, + "workspace_padding": { + "description": "Workspace padding (default: global)", + "type": "integer", + "format": "int32" + }, + "workspace_rules": { + "description": "Permanent workspace application rules", + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + } + } + ] + } + } + } + } + } + } + } + }, + "mouse_follows_focus": { + "description": "Enable or disable mouse follows focus (default: true)", + "type": "boolean" + }, + "object_name_change_applications": { + "description": "Identify applications that send EVENT_OBJECT_NAMECHANGE on launch (very rare)", + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + } + } + ] + } + }, + "object_name_change_title_ignore_list": { + "description": "Do not process EVENT_OBJECT_NAMECHANGE events as Show events for identified applications matching these title regexes", + "type": "array", + "items": { + "type": "string" + } + }, + "resize_delta": { + "description": "Delta to resize windows by (default 50)", + "type": "integer", + "format": "int32" + }, + "toggle_float_placement": { + "description": "Determines the placement of a new window when toggling to float (default: CenterAndResize)", + "oneOf": [ + { + "description": "Does not change the size or position of the window", + "type": "string", + "enum": [ + "None" + ] + }, + { + "description": "Center the window without changing the size", + "type": "string", + "enum": [ + "Center" + ] + }, + { + "description": "Center the window and resize it according to the `AspectRatio`", + "type": "string", + "enum": [ + "CenterAndResize" + ] + } + ] + }, + "tray_and_multi_window_applications": { + "description": "Identify tray and multi-window applications", + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "kind" + ], + "properties": { + "id": { + "type": "string" + }, + "kind": { + "type": "string", + "enum": [ + "Exe", + "Class", + "Title", + "Path" + ] + }, + "matching_strategy": { + "type": "string", + "enum": [ + "Legacy", + "Equals", + "StartsWith", + "EndsWith", + "Contains", + "Regex", + "DoesNotEndWith", + "DoesNotStartWith", + "DoesNotEqual", + "DoesNotContain" + ] + } + } + } + } + ] + } + }, + "unmanaged_window_operation_behaviour": { + "description": "Determine what happens when commands are sent while an unmanaged window is in the foreground (default: Op)", + "oneOf": [ + { + "description": "Process komorebic commands on temporarily unmanaged/floated windows", + "type": "string", + "enum": [ + "Op" + ] + }, + { + "description": "Ignore komorebic commands on temporarily unmanaged/floated windows", + "type": "string", + "enum": [ + "NoOp" + ] + } + ] + }, + "window_container_behaviour": { + "description": "Determine what happens when a new window is opened (default: Create)", + "oneOf": [ + { + "description": "Create a new container for each new window", + "type": "string", + "enum": [ + "Create" + ] + }, + { + "description": "Append new windows to the focused window container", + "type": "string", + "enum": [ + "Append" + ] + } + ] + } + } +}