refactor(repo): move the KDE and macOS docs under docs/ (pure move)

komorebi-for-kde/docs/ -> docs/linux/
komorebi-for-mac/docs/ -> docs/macos/

The Windows docs stay where they are (docs/). Renames only, so links and include paths
that named the old directories are broken at this revision; they are fixed in the revision
that fixes the paths of the whole layout move.
This commit is contained in:
LGUG2Z committed 2026-11-05 15:03:27 -08:00
1 parent 348cb7ae96
commit d781028a2a
390 files changed

No files matched your search

@@ -0,0 +1,21 @@
# adjust-container-padding
```
Adjust container padding on the focused workspace
Usage: komorebic adjust-container-padding <SIZING> <ADJUSTMENT>
Arguments:
<SIZING>
Possible values:
- increase: Increase
- decrease: Decrease
<ADJUSTMENT>
Pixels to adjust by as an integer
Options:
-h, --help
Print help (see a summary with '-h')
```
@@ -0,0 +1,21 @@
# adjust-workspace-padding
```
Adjust workspace padding on the focused workspace
Usage: komorebic adjust-workspace-padding <SIZING> <ADJUSTMENT>
Arguments:
<SIZING>
Possible values:
- increase: Increase
- decrease: Decrease
<ADJUSTMENT>
Pixels to adjust by as an integer
Options:
-h, --help
Print help (see a summary with '-h')
```
+24
View File
@@ -0,0 +1,24 @@
# animation-duration
```
Set the duration for movement animations in ms
Usage: komorebic animation-duration [OPTIONS] <DURATION>
Arguments:
<DURATION>
Desired animation durations in ms
Options:
-a, --animation-type <ANIMATION_TYPE>
Animation type to apply the duration to. If not specified, sets global duration
Possible values:
- movement
- transparency
- workspace: A workspace sliding in and out of a monitor when it is switched to
-h, --help
Print help (see a summary with '-h')
```
+16
View File
@@ -0,0 +1,16 @@
# animation-fps
```
Set the frames per second for movement animations
Usage: komorebic animation-fps <FPS>
Arguments:
<FPS>
Desired animation frames per second
Options:
-h, --help
Print help
```
+58
View File
@@ -0,0 +1,58 @@
# animation-style
```
Set the ease function for movement animations
Usage: komorebic 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]
-a, --animation-type <ANIMATION_TYPE>
Animation type to apply the style to. If not specified, sets global style
Possible values:
- movement
- transparency
- workspace: A workspace sliding in and out of a monitor when it is switched to
-h, --help
Print help (see a summary with '-h')
```
+24
View File
@@ -0,0 +1,24 @@
# animation
```
Enable or disable movement animations
Usage: komorebic animation [OPTIONS] <BOOLEAN_STATE>
Arguments:
<BOOLEAN_STATE>
[possible values: enable, disable]
Options:
-a, --animation-type <ANIMATION_TYPE>
Animation type to apply the state to. If not specified, sets global state
Possible values:
- movement
- transparency
- workspace: A workspace sliding in and out of a monitor when it is switched to
-h, --help
Print help (see a summary with '-h')
```
@@ -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
```
+33
View File
@@ -0,0 +1,33 @@
# border-colour
```
Set the colour for a window border kind
Usage: komorebic border-colour [OPTIONS] <R> <G> <B>
Arguments:
<R>
Red
<G>
Green
<B>
Blue
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]
-h, --help
Print help (see a summary with '-h')
```
+16
View File
@@ -0,0 +1,16 @@
# border-offset
```
Set the border offset
Usage: komorebic border-offset <OFFSET>
Arguments:
<OFFSET>
Desired offset of the window border
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# border-width
```
Set the border width
Usage: komorebic border-width <WIDTH>
Arguments:
<WIDTH>
Desired width of the window border
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# border
```
Enable or disable borders
Usage: komorebic border <BOOLEAN_STATE>
Arguments:
<BOOLEAN_STATE>
[possible values: enable, disable]
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# cancel-preselect
```
Cancel a workspace preselect set by the preselect-direction command, if one exists
Usage: komorebic cancel-preselect
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# center-focus
```
Scroll the Scrolling layout so that the focused column is in the middle of the screen, once
Usage: komorebic center-focus
Options:
-h, --help
Print help
```
+25
View File
@@ -0,0 +1,25 @@
# change-layout
```
Set the layout on the focused workspace
Usage: komorebic change-layout <DEFAULT_LAYOUT>
Arguments:
<DEFAULT_LAYOUT>
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 (see a summary with '-h')
```
@@ -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
```
@@ -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 <WORKSPACE>
Arguments:
<WORKSPACE>
Target workspace name
Options:
-h, --help
Print help
```
@@ -0,0 +1,16 @@
# clear-named-workspace-rules
```
Remove all application association rules for a named workspace
Usage: komorebic clear-named-workspace-rules <WORKSPACE>
Arguments:
<WORKSPACE>
Name of a workspace
Options:
-h, --help
Print help
```
@@ -0,0 +1,12 @@
# clear-session-float-rules
```
Clear all session float rules
Usage: komorebic clear-session-float-rules
Options:
-h, --help
Print help
```
@@ -0,0 +1,19 @@
# clear-workspace-layout-rules
```
Clear all dynamic layout rules for the specified workspace
Usage: komorebic clear-workspace-layout-rules <MONITOR> <WORKSPACE>
Arguments:
<MONITOR>
Monitor index (zero-indexed)
<WORKSPACE>
Workspace index on the specified monitor (zero-indexed)
Options:
-h, --help
Print help
```
+19
View File
@@ -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 <MONITOR> <WORKSPACE>
Arguments:
<MONITOR>
Monitor index (zero-indexed)
<WORKSPACE>
Workspace index on the specified monitor (zero-indexed)
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# close-workspace
```
Close the focused workspace (must be empty and unnamed)
Usage: komorebic close-workspace
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# close
```
Close the focused window
Usage: komorebic close
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# completions
```
Generate komorebic CLI completions for the target shell
Usage: komorebic completions <SHELL>
Arguments:
<SHELL>
[possible values: bash, elvish, fish, powershell, zsh]
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# configuration
```
Show the path to komorebi.json
Usage: komorebic configuration
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# consume
```
Take the neighbouring window on one side into the focused column of the Scrolling layout
Usage: komorebic consume <OPERATION_DIRECTION>
Arguments:
<OPERATION_DIRECTION>
[possible values: left, right, up, down]
Options:
-h, --help
Print help
```
+22
View File
@@ -0,0 +1,22 @@
# container-padding
```
Set the container padding for the specified workspace
Usage: komorebic container-padding <MONITOR> <WORKSPACE> <SIZE>
Arguments:
<MONITOR>
Monitor index (zero-indexed)
<WORKSPACE>
Workspace index on the specified monitor (zero-indexed)
<SIZE>
Pixels to pad with as an integer
Options:
-h, --help
Print help
```
@@ -0,0 +1,21 @@
# cross-monitor-move-behaviour
```
Set the behaviour when moving windows across monitor boundaries
Usage: komorebic cross-monitor-move-behaviour <MOVE_BEHAVIOUR>
Arguments:
<MOVE_BEHAVIOUR>
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')
```
+16
View File
@@ -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 <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# cycle-focus
```
Change focus to the window in the specified cycle direction
Usage: komorebic cycle-focus <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# cycle-layout
```
Cycle between available layouts
Usage: komorebic cycle-layout <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# cycle-monitor
```
Focus the monitor in the given cycle direction
Usage: komorebic cycle-monitor <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -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 <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -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 <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
@@ -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 <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# cycle-move
```
Move the focused window in the specified cycle direction
Usage: komorebic cycle-move <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -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 <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -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 <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -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 <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# cycle-stack
```
Cycle the focused stack in the specified cycle direction
Usage: komorebic cycle-stack <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# cycle-workspace
```
Focus the workspace in the given cycle direction
Usage: komorebic cycle-workspace <CYCLE_DIRECTION>
Arguments:
<CYCLE_DIRECTION>
[possible values: previous, next]
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# data-directory
```
Show the path to komorebi's data directory in $HOME/Library/Application Support
Usage: komorebic data-directory
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# disable-autostart
```
Unloads and deletes the com.lgug2z.komorebi.plist file in $HOME/Library/LaunchAgents
Usage: komorebic disable-autostart
Options:
-h, --help
Print help
```
@@ -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 <INDEX_PREFERENCE> <DISPLAY>
Arguments:
<INDEX_PREFERENCE>
Preferred monitor index (zero-indexed)
<DISPLAY>
Display name as identified in komorebic state
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# eager-focus
```
Focus the first managed window matching the given executable
Usage: komorebic eager-focus <EXE>
Arguments:
<EXE>
Case-sensitive exe identifier
Options:
-h, --help
Print help
```
+18
View File
@@ -0,0 +1,18 @@
# enable-autostart
```
Generates and loads the com.lgug2z.komorebi.plist file in $HOME/Library/LaunchAgents
Usage: komorebic enable-autostart [OPTIONS]
Options:
-c, --config <CONFIG>
Path to a static configuration JSON file
--bar
Enable autostart of komorebi-bar
-h, --help
Print help
```
+12
View File
@@ -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
```
+19
View File
@@ -0,0 +1,19 @@
# ensure-named-workspaces
```
Create these many named workspaces for the specified monitor
Usage: komorebic ensure-named-workspaces <MONITOR> [NAMES]...
Arguments:
<MONITOR>
Monitor index (zero-indexed)
[NAMES]...
Names of desired workspaces
Options:
-h, --help
Print help
```
+19
View File
@@ -0,0 +1,19 @@
# ensure-workspaces
```
Create at least this many workspaces for the specified monitor
Usage: komorebic ensure-workspaces <MONITOR> <WORKSPACE_COUNT>
Arguments:
<MONITOR>
Monitor index (zero-indexed)
<WORKSPACE_COUNT>
Number of desired workspaces
Options:
-h, --help
Print help
```
+13
View File
@@ -0,0 +1,13 @@
# expand
```
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: komorebic expand
Options:
-h, --help
Print help
```
+13
View File
@@ -0,0 +1,13 @@
# expel
```
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: komorebic expel
Options:
-h, --help
Print help
```
@@ -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
```
+19
View File
@@ -0,0 +1,19 @@
# flip-layout
```
Flip the layout on the focused workspace
Usage: komorebic flip-layout <AXIS>
Arguments:
<AXIS>
Possible values:
- horizontal: Horizontal axis
- vertical: Vertical axis
- horizontal-and-vertical: Both horizontal and vertical axes
Options:
-h, --help
Print help (see a summary with '-h')
```
+12
View File
@@ -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
```
+12
View File
@@ -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
```
+19
View File
@@ -0,0 +1,19 @@
# focus-monitor-workspace
```
Focus the specified workspace on the target monitor
Usage: komorebic focus-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>
Arguments:
<TARGET_MONITOR>
Target monitor index (zero-indexed)
<TARGET_WORKSPACE>
Workspace index on the target monitor (zero-indexed)
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# focus-monitor
```
Focus the specified monitor
Usage: komorebic focus-monitor <TARGET>
Arguments:
<TARGET>
Target index (zero-indexed)
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# focus-named-workspace
```
Focus the specified workspace
Usage: komorebic focus-named-workspace <WORKSPACE>
Arguments:
<WORKSPACE>
Target workspace name
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# focus-stack-window
```
Focus the specified window index in the focused stack
Usage: komorebic focus-stack-window <TARGET>
Arguments:
<TARGET>
Target index (zero-indexed)
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# focus-workspace
```
Focus the specified workspace on the focused monitor
Usage: komorebic focus-workspace <TARGET>
Arguments:
<TARGET>
Target index (zero-indexed)
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# focus-workspaces
```
Focus the specified workspace on all monitors
Usage: komorebic focus-workspaces <TARGET>
Arguments:
<TARGET>
Target index (zero-indexed)
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# focus
```
Change focus to the window in the specified direction
Usage: komorebic focus <OPERATION_DIRECTION>
Arguments:
<OPERATION_DIRECTION>
[possible values: left, right, up, down]
Options:
-h, --help
Print help
```
@@ -0,0 +1,16 @@
# focused-workspace-container-padding
```
Set container padding on the focused workspace
Usage: komorebic focused-workspace-container-padding <SIZE>
Arguments:
<SIZE>
Pixels size to set as an integer
Options:
-h, --help
Print help
```
@@ -0,0 +1,16 @@
# focused-workspace-padding
```
Set workspace padding on the focused workspace
Usage: komorebic focused-workspace-padding <SIZE>
Arguments:
<SIZE>
Pixels size to set as an integer
Options:
-h, --help
Print help
```
+12
View File
@@ -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
```
+12
View File
@@ -0,0 +1,12 @@
# global-state
```
Show a JSON representation of the current global state
Usage: komorebic global-state
Options:
-h, --help
Print help
```
+25
View File
@@ -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 <LEFT> <TOP> <RIGHT> <BOTTOM>
Arguments:
<LEFT>
Size of the left work area offset (set right to left * 2 to maintain right padding)
<TOP>
Size of the top work area offset (set bottom to the same value to maintain bottom padding)
<RIGHT>
Size of the right work area offset
<BOTTOM>
Size of the bottom work area offset
Options:
-h, --help
Print help
```
+23
View File
@@ -0,0 +1,23 @@
# ignore-rule
```
Add a rule to ignore the specified application
Usage: komorebic ignore-rule <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
Possible values:
- exe: Executable name
- class: Role or subrole
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help (see a summary with '-h')
```
@@ -0,0 +1,26 @@
# initial-named-workspace-rule
```
Add a rule to associate an application with a named workspace on first show
Usage: komorebic initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments:
<IDENTIFIER>
Possible values:
- exe: Executable name
- class: Role or subrole
- title: Window title
- path: Executable path
<ID>
Identifier as a string
<WORKSPACE>
Name of a workspace
Options:
-h, --help
Print help (see a summary with '-h')
```
+29
View File
@@ -0,0 +1,29 @@
# initial-workspace-rule
```
Add a rule to associate an application with a workspace on first show
Usage: komorebic initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
Arguments:
<IDENTIFIER>
Possible values:
- exe: Executable name
- class: Role or subrole
- title: Window title
- path: Executable path
<ID>
Identifier as a string
<MONITOR>
Monitor index (zero-indexed)
<WORKSPACE>
Workspace index on the specified monitor (zero-indexed)
Options:
-h, --help
Print help (see a summary with '-h')
```
+18
View File
@@ -0,0 +1,18 @@
# layout-ratios
```
Set the layout column and row ratios for the focused workspace
Usage: komorebic 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
```
+16
View File
@@ -0,0 +1,16 @@
# license
```
Specify an email associated with an Individual Commercial Use License
Usage: komorebic license <EMAIL>
Arguments:
<EMAIL>
Email address associated with an Individual Commercial Use License
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# load-resize
```
Load the resize layout dimensions from a file
Usage: komorebic load-resize <PATH>
Arguments:
<PATH>
File from which the resize layout dimensions should be loaded
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# log
```
Tail komorebi's process logs (cancel with Ctrl-C)
Usage: komorebic log
Options:
-h, --help
Print help
```
+23
View File
@@ -0,0 +1,23 @@
# manage-rule
```
Add a rule to always manage the specified application
Usage: komorebic manage-rule <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
Possible values:
- exe: Executable name
- class: Role or subrole
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help (see a summary with '-h')
```
+12
View File
@@ -0,0 +1,12 @@
# manage
```
Force komorebi to manage the focused window
Usage: komorebic manage
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# minimize
```
Minimize the focused window
Usage: komorebic minimize
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# monitor-information
```
Show information about connected monitors
Usage: komorebic monitor-information
Options:
-h, --help
Print help
```
@@ -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 <MONITOR> <LEFT> <TOP> <RIGHT> <BOTTOM>
Arguments:
<MONITOR>
Monitor index (zero-indexed)
<LEFT>
Size of the left work area offset (set right to left * 2 to maintain right padding)
<TOP>
Size of the top work area offset (set bottom to the same value to maintain bottom padding)
<RIGHT>
Size of the right work area offset
<BOTTOM>
Size of the bottom work area offset
Options:
-h, --help
Print help
```
+20
View File
@@ -0,0 +1,20 @@
# monocle-focus-behaviour
```
Set the behaviour when focusing in a direction while a monocle container is active
Usage: komorebic 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')
```
+16
View File
@@ -0,0 +1,16 @@
# mouse-follows-focus
```
Enable or disable mouse follows focus on all workspaces
Usage: komorebic mouse-follows-focus <BOOLEAN_STATE>
Arguments:
<BOOLEAN_STATE>
[possible values: enable, disable]
Options:
-h, --help
Print help
```
+12
View File
@@ -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
```
@@ -0,0 +1,19 @@
# move-to-monitor-workspace
```
Move the focused window to the specified monitor workspace
Usage: komorebic move-to-monitor-workspace <TARGET_MONITOR> <TARGET_WORKSPACE>
Arguments:
<TARGET_MONITOR>
Target monitor index (zero-indexed)
<TARGET_WORKSPACE>
Workspace index on the target monitor (zero-indexed)
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# move-to-monitor
```
Move the focused window to the specified monitor
Usage: komorebic move-to-monitor <TARGET>
Arguments:
<TARGET>
Target index (zero-indexed)
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# move-to-named-workspace
```
Move the focused window to the specified workspace
Usage: komorebic move-to-named-workspace <WORKSPACE>
Arguments:
<WORKSPACE>
Target workspace name
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# move-to-workspace
```
Move the focused window to the specified workspace
Usage: komorebic move-to-workspace <TARGET>
Arguments:
<TARGET>
Target index (zero-indexed)
Options:
-h, --help
Print help
```
@@ -0,0 +1,16 @@
# move-workspace-to-monitor
```
Move the focused workspace to the specified monitor
Usage: komorebic move-workspace-to-monitor <TARGET>
Arguments:
<TARGET>
Target index (zero-indexed)
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# move
```
Move the focused window in the specified direction
Usage: komorebic move <OPERATION_DIRECTION>
Arguments:
<OPERATION_DIRECTION>
[possible values: left, right, up, down]
Options:
-h, --help
Print help
```
@@ -0,0 +1,19 @@
# named-workspace-container-padding
```
Set the container padding for the specified workspace
Usage: komorebic named-workspace-container-padding <WORKSPACE> <SIZE>
Arguments:
<WORKSPACE>
Target workspace name
<SIZE>
Pixels to pad with as an integer
Options:
-h, --help
Print help
```
@@ -0,0 +1,31 @@
# named-workspace-layout-rule
```
Add a dynamic layout rule for the specified workspace
Usage: komorebic named-workspace-layout-rule <WORKSPACE> <AT_CONTAINER_COUNT> <LAYOUT>
Arguments:
<WORKSPACE>
Target workspace name
<AT_CONTAINER_COUNT>
The number of window containers on-screen required to trigger this layout rule
<LAYOUT>
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 (see a summary with '-h')
```
+28
View File
@@ -0,0 +1,28 @@
# named-workspace-layout
```
Set the layout for the specified workspace
Usage: komorebic named-workspace-layout <WORKSPACE> <VALUE>
Arguments:
<WORKSPACE>
Target workspace name
<VALUE>
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 (see a summary with '-h')
```
+19
View File
@@ -0,0 +1,19 @@
# named-workspace-padding
```
Set the workspace padding for the specified workspace
Usage: komorebic named-workspace-padding <WORKSPACE> <SIZE>
Arguments:
<WORKSPACE>
Target workspace name
<SIZE>
Pixels to pad with as an integer
Options:
-h, --help
Print help
```
+26
View File
@@ -0,0 +1,26 @@
# named-workspace-rule
```
Add a rule to associate an application with a named workspace
Usage: komorebic named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments:
<IDENTIFIER>
Possible values:
- exe: Executable name
- class: Role or subrole
- title: Window title
- path: Executable path
<ID>
Identifier as a string
<WORKSPACE>
Name of a workspace
Options:
-h, --help
Print help (see a summary with '-h')
```
+19
View File
@@ -0,0 +1,19 @@
# named-workspace-tiling
```
Enable or disable window tiling for the specified workspace
Usage: komorebic named-workspace-tiling <WORKSPACE> <VALUE>
Arguments:
<WORKSPACE>
Target workspace name
<VALUE>
[possible values: enable, disable]
Options:
-h, --help
Print help
```
+12
View File
@@ -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
```
+12
View File
@@ -0,0 +1,12 @@
# notification-schema
```
Generate a JSON Schema of subscription notifications
Usage: komorebic notification-schema
Options:
-h, --help
Print help
```
+45
View File
@@ -0,0 +1,45 @@
# pan
```
Move the view of the Scrolling layout a column to the left or the right, or with the fingers on a
touchpad
The strip of columns moves by the width of a new column and comes to rest with a column against an
edge of the screen. Focus stays on the column that has it if that is still fully in view, and
otherwise goes to the nearest column that is. Only the Scrolling layout has a strip to move, so this
does nothing in the other layouts.
With --stream the strip follows the fingers as they go, 10 centimetres of travel being the width of
the screen, until they lift, and then comes to rest in the column that the speed that they lifted at
takes it to. Standard input is the gesture stream that whkd writes on Windows, one message to a
line: `begin`, `move dx=<cm> t=<ms>`, `end` and `cancel`. A gesture that is not finished when
standard input closes is given up, and the strip goes back to where it was.
Usage: komorebic pan [OPTIONS] [DIRECTION]
Arguments:
[DIRECTION]
The way that the view goes
[possible values: left, right]
Options:
--stream
Read the gestures of fingers on a touchpad from standard input, in the gesture stream that
whkd writes for a swipe of three or four fingers, and pan with them
--sensitivity <SENSITIVITY>
What the distances of a gesture are multiplied by, which is 1 if it is left out, with
--stream
--reversed
Go the other way to the fingers, with --stream
--paging
Take a step for every two centimetres that the fingers go, and not move the view with
them, with --stream
-h, --help
Print help (see a summary with '-h')
```
+12
View File
@@ -0,0 +1,12 @@
# permissions
```
Show the System Settings permissions dialogs required by komorebi
Usage: komorebic permissions
Options:
-h, --help
Print help
```
+16
View File
@@ -0,0 +1,16 @@
# preselect-direction
```
Preselect the specified direction for the next window to be spawned on supported layouts
Usage: komorebic preselect-direction <OPERATION_DIRECTION>
Arguments:
<OPERATION_DIRECTION>
[possible values: left, right, up, down]
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# promote-focus
```
Promote the user focus to the largest window container
Usage: komorebic promote-focus
Options:
-h, --help
Print help
```
+12
View File
@@ -0,0 +1,12 @@
# promote-swap
```
Promote the focused window to the largest tile by swapping container indices with the largest tile
Usage: komorebic promote-swap
Options:
-h, --help
Print help
```
Loaded 100 of 390 files, more files were not shown because too many files have changed in this diff. Show more