docs(cli): regenerate the stale Windows command pages

docs/cli lagged behind the Windows komorebic: 35 pages had out-of-date
help text (possible values now listed with their descriptions, new doc
comments, the Scrolling commands without the komorebic.exe usage name) and
3 pages did not exist yet. They are regenerated from the current Windows
CLI definition (komorebic-core docgen-all example, platform windows,
COLUMNS=1000 so nothing is re-wrapped like the existing pages), and the
page conventions of each file are kept: header line only where the page had
one, komorebic.exe as the binary name, trailing newline. The other 149
pages are byte-identical to the fresh output. The KDE and macOS pages are
untouched (decision D20: Windows was the only stale set).

Docs only, no behaviour. Verified: regenerated twice, second compare shows no
diff; the real Windows binary was not run (the pages come from the shared
definition rendered on Linux, class text normalised to the Windows one).
This commit is contained in:
LGUG2Z committed 2026-11-05 15:03:26 -08:00
1 parent 3cc8ff63b3
commit 0f851bfb0a
38 files changed
+270 -80

No files matched your search

+4 -2
View File
@@ -7,13 +7,15 @@ Usage: komorebic.exe adjust-container-padding <SIZING> <ADJUSTMENT>
Arguments:
<SIZING>
[possible values: increase, decrease]
Possible values:
- increase: Increase
- decrease: Decrease
<ADJUSTMENT>
Pixels to adjust by as an integer
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+4 -2
View File
@@ -7,13 +7,15 @@ Usage: komorebic.exe adjust-workspace-padding <SIZING> <ADJUSTMENT>
Arguments:
<SIZING>
[possible values: increase, decrease]
Possible values:
- increase: Increase
- decrease: Decrease
<ADJUSTMENT>
Pixels to adjust by as an integer
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -3
View File
@@ -12,10 +12,13 @@ Arguments:
Options:
-a, --animation-type <ANIMATION_TYPE>
Animation type to apply the duration to. If not specified, sets global duration
[possible values: movement, transparency, workspace]
Possible values:
- movement
- transparency
- workspace: A workspace sliding in and out of a monitor when it is switched to
-h, --help
Print help
Print help (see a summary with '-h')
```
+39 -5
View File
@@ -8,17 +8,51 @@ Usage: komorebic.exe animation-style [OPTIONS]
Options:
-s, --style <STYLE>
Desired ease function for animation
Possible values:
- linear: Linear
- ease-in-sine: Ease in sine
- ease-out-sine: Ease out sine
- ease-in-out-sine: Ease in out sine
- ease-in-quad: Ease in quad
- ease-out-quad: Ease out quad
- ease-in-out-quad: Ease in out quad
- ease-in-cubic: Ease in cubic
- ease-out-cubic: Ease out cubic
- ease-in-out-cubic: Ease in out cubic
- ease-in-quart: Ease in quart
- ease-out-quart: Ease out quart
- ease-in-out-quart: Ease in out quart
- ease-in-quint: Ease in quint
- ease-out-quint: Ease out quint
- ease-in-out-quint: Ease in out quint
- ease-in-expo: Ease in expo
- ease-out-expo: Ease out expo
- ease-in-out-expo: Ease in out expo
- ease-in-circ: Ease in circ
- ease-out-circ: Ease out circ
- ease-in-out-circ: Ease in out circ
- ease-in-back: Ease in back
- ease-out-back: Ease out back
- ease-in-out-back: Ease in out back
- ease-in-elastic: Ease in elastic
- ease-out-elastic: Ease out elastic
- ease-in-out-elastic: Ease in out elastic
- ease-in-bounce: Ease in bounce
- ease-out-bounce: Ease out bounce
- ease-in-out-bounce: Ease in out bounce
[default: linear]
[possible values: linear, ease-in-sine, ease-out-sine, ease-in-out-sine, ease-in-quad, ease-out-quad, ease-in-out-quad, ease-in-cubic, ease-in-out-cubic, ease-in-quart, ease-out-quart, ease-in-out-quart, ease-in-quint, ease-out-quint, ease-in-out-quint, ease-in-expo,
ease-out-expo, ease-in-out-expo, ease-in-circ, ease-out-circ, ease-in-out-circ, ease-in-back, ease-out-back, ease-in-out-back, ease-in-elastic, ease-out-elastic, ease-in-out-elastic, ease-in-bounce, ease-out-bounce, ease-in-out-bounce]
-a, --animation-type <ANIMATION_TYPE>
Animation type to apply the style to. If not specified, sets global style
[possible values: movement, transparency, workspace]
Possible values:
- movement
- transparency
- workspace: A workspace sliding in and out of a monitor when it is switched to
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -3
View File
@@ -12,10 +12,13 @@ Arguments:
Options:
-a, --animation-type <ANIMATION_TYPE>
Animation type to apply the state to. If not specified, sets global state
[possible values: movement, transparency, workspace]
Possible values:
- movement
- transparency
- workspace: A workspace sliding in and out of a monitor when it is switched to
-h, --help
Print help
Print help (see a summary with '-h')
```
+9 -2
View File
@@ -17,10 +17,17 @@ Arguments:
Options:
-w, --window-kind <WINDOW_KIND>
Possible values:
- single: Single window
- stack: Stack container
- monocle: Monocle container
- unfocused: Unfocused window
- unfocused-locked: Unfocused locked container
- floating: Floating window
[default: single]
[possible values: single, stack, monocle, unfocused, unfocused-locked, floating]
-h, --help
Print help
Print help (see a summary with '-h')
```
+2 -2
View File
@@ -1,10 +1,10 @@
```
Scroll the Scrolling layout so that the focused column is in the middle of the screen, once
Usage: center-focus
Usage: komorebic.exe center-focus
Options:
-h, --help
Print help
```
```
+11 -2
View File
@@ -7,10 +7,19 @@ Usage: komorebic.exe change-layout <DEFAULT_LAYOUT>
Arguments:
<DEFAULT_LAYOUT>
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
Possible values:
- bsp: BSP Layout
- columns: Columns Layout
- rows: Rows Layout
- vertical-stack: Vertical Stack Layout
- horizontal-stack: Horizontal Stack Layout
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
- grid: Grid Layout
- right-main-vertical-stack: Right Main Vertical Stack Layout
- scrolling: Scrolling Layout
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+2 -2
View File
@@ -1,7 +1,7 @@
```
Take the neighbouring window on one side into the focused column of the Scrolling layout
Usage: consume <OPERATION_DIRECTION>
Usage: komorebic.exe consume <OPERATION_DIRECTION>
Arguments:
<OPERATION_DIRECTION>
@@ -11,4 +11,4 @@ Options:
-h, --help
Print help
```
```
+1 -1
View File
@@ -1,7 +1,7 @@
```
Make the focused column of the Scrolling layout fill the room that the columns in view leave on the screen, which does nothing in any other layout
Usage: expand
Usage: komorebic.exe expand
Options:
-h, --help
+3 -4
View File
@@ -1,11 +1,10 @@
```
Take the focused window out of its column in the Scrolling layout and put it in a column of its own
on the right
Take the focused window out of its column in the Scrolling layout and put it in a column of its own on the right
Usage: expel
Usage: komorebic.exe expel
Options:
-h, --help
Print help
```
```
+5 -2
View File
@@ -7,10 +7,13 @@ Usage: komorebic.exe flip-layout <AXIS>
Arguments:
<AXIS>
[possible values: horizontal, vertical, horizontal-and-vertical]
Possible values:
- horizontal: Horizontal axis
- vertical: Vertical axis
- horizontal-and-vertical: Both horizontal and vertical axes
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -7,13 +7,17 @@ Usage: komorebic.exe identify-layered-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
@@ -7,13 +7,17 @@ Usage: komorebic.exe identify-object-name-change-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -7,13 +7,17 @@ Usage: komorebic.exe identify-tray-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -7,13 +7,17 @@ Usage: komorebic.exe ignore-rule <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -7,7 +7,11 @@ Usage: komorebic.exe initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
@@ -17,6 +21,6 @@ Arguments:
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -7,7 +7,11 @@ Usage: komorebic.exe initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPA
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
@@ -20,6 +24,6 @@ Arguments:
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+16
View File
@@ -0,0 +1,16 @@
```
Set the layout column and row ratios for the focused workspace
Usage: komorebic.exe layout-ratios [OPTIONS]
Options:
-c, --columns <COLUMNS>...
Column width ratios (space-separated values between 0.1 and 0.9)
-r, --rows <ROWS>...
Row height ratios (space-separated values between 0.1 and 0.9)
-h, --help
Print help
```
+6 -2
View File
@@ -7,13 +7,17 @@ Usage: komorebic.exe manage-rule <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+18
View File
@@ -0,0 +1,18 @@
```
Set the behaviour when focusing in a direction while a monocle container is active
Usage: komorebic.exe monocle-focus-behaviour <BEHAVIOUR>
Arguments:
<BEHAVIOUR>
Desired monocle focus behaviour
Possible values:
- cycle: Cycle the monocle container to the next/previous container in the workspace
- no-op: Do nothing, allowing focus to fall through to cross-monitor logic
Options:
-h, --help
Print help (see a summary with '-h')
```
+11 -2
View File
@@ -13,10 +13,19 @@ Arguments:
The number of window containers on-screen required to trigger this layout rule
<LAYOUT>
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
Possible values:
- bsp: BSP Layout
- columns: Columns Layout
- rows: Rows Layout
- vertical-stack: Vertical Stack Layout
- horizontal-stack: Horizontal Stack Layout
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
- grid: Grid Layout
- right-main-vertical-stack: Right Main Vertical Stack Layout
- scrolling: Scrolling Layout
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+11 -2
View File
@@ -10,10 +10,19 @@ Arguments:
Target workspace name
<VALUE>
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
Possible values:
- bsp: BSP Layout
- columns: Columns Layout
- rows: Rows Layout
- vertical-stack: Vertical Stack Layout
- horizontal-stack: Horizontal Stack Layout
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
- grid: Grid Layout
- right-main-vertical-stack: Right Main Vertical Stack Layout
- scrolling: Scrolling Layout
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -7,7 +7,11 @@ Usage: komorebic.exe named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
@@ -17,6 +21,6 @@ Arguments:
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+1 -1
View File
@@ -1,7 +1,7 @@
```
Move the view of the Scrolling layout a column to the left or the right, or with the fingers on a touchpad, which does nothing in any other layout
Usage: pan [OPTIONS] [DIRECTION]
Usage: komorebic.exe pan [OPTIONS] [DIRECTION]
Arguments:
[DIRECTION]
+6 -2
View File
@@ -7,13 +7,17 @@ Usage: komorebic.exe remove-title-bar <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+8 -3
View File
@@ -7,13 +7,18 @@ Usage: komorebic.exe resize-axis <AXIS> <SIZING>
Arguments:
<AXIS>
[possible values: horizontal, vertical, horizontal-and-vertical]
Possible values:
- horizontal: Horizontal axis
- vertical: Vertical axis
- horizontal-and-vertical: Both horizontal and vertical axes
<SIZING>
[possible values: increase, decrease]
Possible values:
- increase: Increase
- decrease: Decrease
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+4 -2
View File
@@ -10,10 +10,12 @@ Arguments:
[possible values: left, right, up, down]
<SIZING>
[possible values: increase, decrease]
Possible values:
- increase: Increase
- decrease: Decrease
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+3 -4
View File
@@ -1,11 +1,10 @@
```
Make the focused column of the Scrolling layout as wide as the screen, or put it back to the width
that it had
Make the focused column of the Scrolling layout as wide as the screen, or put it back to the width that it had
Usage: scrolling-layout-full-width
Usage: komorebic.exe scrolling-layout-full-width
Options:
-h, --help
Print help
```
```
+6 -3
View File
@@ -8,11 +8,14 @@ Usage: komorebic.exe stackbar-mode <MODE>
Arguments:
<MODE>
Desired stackbar mode
[possible values: always, never, on-stack]
Possible values:
- always: Always show
- never: Never show
- on-stack: Show on stack
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+1 -1
View File
@@ -10,7 +10,7 @@ Options:
Path to a static configuration JSON file
-a, --await-configuration
Wait for 'komorebic complete-configuration' to be sent before processing events
Wait for `komorebic complete-configuration` to be sent before processing events
-t, --tcp-port <TCP_PORT>
Start a TCP server on the given port to allow the direct sending of SocketMessages
+3 -4
View File
@@ -1,11 +1,10 @@
```
Stack the windows of the focused column of the Scrolling layout, or spread the focused stack out
into a column with a window in each slot
Stack the windows of the focused column of the Scrolling layout, or spread the focused stack out into a column with a window in each slot
Usage: toggle-column-stack
Usage: komorebic.exe toggle-column-stack
Options:
-h, --help
Print help
```
```
@@ -0,0 +1,10 @@
```
Toggle the behaviour when focusing in a direction while a monocle container is active
Usage: komorebic.exe toggle-monocle-focus-behaviour
Options:
-h, --help
Print help
```
@@ -8,8 +8,8 @@ Usage: komorebic.exe unmanaged-window-operation-behaviour <OPERATION_BEHAVIOUR>
Arguments:
<OPERATION_BEHAVIOUR>
Possible values:
- op: Process komorebic commands on temporarily unmanaged/floated windows
- no-op: Ignore komorebic commands on temporarily unmanaged/floated windows
- op: Process commands on temporarily unmanaged/floated windows
- no-op: Ignore commands on temporarily unmanaged/floated windows
Options:
-h, --help
+2 -2
View File
@@ -8,8 +8,8 @@ Usage: komorebic.exe window-hiding-behaviour <HIDING_BEHAVIOUR>
Arguments:
<HIDING_BEHAVIOUR>
Possible values:
- hide: END OF LIFE FEATURE: Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps)
- minimize: Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching)
- hide: END OF LIFE FEATURE: Use the `SW_HIDE` flag to hide windows when switching workspaces (has issues with Electron apps)
- minimize: Use the `SW_MINIMIZE` flag to hide windows when switching workspaces (has issues with frequent workspace switching)
- cloak: Use the undocumented SetCloak Win32 function to hide windows when switching workspaces
Options:
+11 -2
View File
@@ -16,10 +16,19 @@ Arguments:
The number of window containers on-screen required to trigger this layout rule
<LAYOUT>
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
Possible values:
- bsp: BSP Layout
- columns: Columns Layout
- rows: Rows Layout
- vertical-stack: Vertical Stack Layout
- horizontal-stack: Horizontal Stack Layout
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
- grid: Grid Layout
- right-main-vertical-stack: Right Main Vertical Stack Layout
- scrolling: Scrolling Layout
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+11 -2
View File
@@ -13,10 +13,19 @@ Arguments:
Workspace index on the specified monitor (zero-indexed)
<VALUE>
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
Possible values:
- bsp: BSP Layout
- columns: Columns Layout
- rows: Rows Layout
- vertical-stack: Vertical Stack Layout
- horizontal-stack: Horizontal Stack Layout
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
- grid: Grid Layout
- right-main-vertical-stack: Right Main Vertical Stack Layout
- scrolling: Scrolling Layout
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -7,7 +7,11 @@ Usage: komorebic.exe workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
@@ -20,6 +24,6 @@ Arguments:
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```