diff --git a/docs/cli/active-window-border-colour.md b/docs/cli/active-window-border-colour.md index 3cf44a28..9a62b927 100644 --- a/docs/cli/active-window-border-colour.md +++ b/docs/cli/active-window-border-colour.md @@ -3,7 +3,7 @@ ``` Set the colour for the active window border -Usage: active-window-border-colour [OPTIONS] +Usage: komorebic.exe active-window-border-colour [OPTIONS] Arguments: @@ -23,4 +23,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/active-window-border-offset.md b/docs/cli/active-window-border-offset.md index ce13c7a2..a40db30a 100644 --- a/docs/cli/active-window-border-offset.md +++ b/docs/cli/active-window-border-offset.md @@ -3,7 +3,7 @@ ``` Set the offset for the active window border -Usage: active-window-border-offset +Usage: komorebic.exe active-window-border-offset Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/active-window-border-width.md b/docs/cli/active-window-border-width.md index 66a62ebf..28001bdf 100644 --- a/docs/cli/active-window-border-width.md +++ b/docs/cli/active-window-border-width.md @@ -3,7 +3,7 @@ ``` Set the width for the active window border -Usage: active-window-border-width +Usage: komorebic.exe active-window-border-width Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/active-window-border.md b/docs/cli/active-window-border.md index d93c4627..405c3688 100644 --- a/docs/cli/active-window-border.md +++ b/docs/cli/active-window-border.md @@ -3,7 +3,7 @@ ``` Enable or disable the active window border -Usage: active-window-border +Usage: komorebic.exe active-window-border Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/adjust-container-padding.md b/docs/cli/adjust-container-padding.md index dcd73610..f8bd2796 100644 --- a/docs/cli/adjust-container-padding.md +++ b/docs/cli/adjust-container-padding.md @@ -3,7 +3,7 @@ ``` Adjust container padding on the focused workspace -Usage: adjust-container-padding +Usage: komorebic.exe adjust-container-padding Arguments: @@ -16,4 +16,4 @@ 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 index 8530ea5d..09fe58c4 100644 --- a/docs/cli/adjust-workspace-padding.md +++ b/docs/cli/adjust-workspace-padding.md @@ -3,7 +3,7 @@ ``` Adjust workspace padding on the focused workspace -Usage: adjust-workspace-padding +Usage: komorebic.exe adjust-workspace-padding Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/ahk-app-specific-configuration.md b/docs/cli/ahk-app-specific-configuration.md index 59a41602..95842961 100644 --- a/docs/cli/ahk-app-specific-configuration.md +++ b/docs/cli/ahk-app-specific-configuration.md @@ -3,7 +3,7 @@ ``` Generate common app-specific configurations and fixes to use in komorebi.ahk -Usage: ahk-app-specific-configuration [OVERRIDE_PATH] +Usage: komorebic.exe ahk-app-specific-configuration [OVERRIDE_PATH] Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/ahk-library.md b/docs/cli/ahk-library.md index 0cc1c8a6..ff197d31 100644 --- a/docs/cli/ahk-library.md +++ b/docs/cli/ahk-library.md @@ -3,10 +3,10 @@ ``` Generate a library of AutoHotKey helper functions -Usage: ahk-library +Usage: komorebic.exe ahk-library Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/alt-focus-hack.md b/docs/cli/alt-focus-hack.md index c46e1ac5..01d08ba4 100644 --- a/docs/cli/alt-focus-hack.md +++ b/docs/cli/alt-focus-hack.md @@ -3,7 +3,7 @@ ``` Enable or disable a hack simulating ALT key presses to ensure focus changes succeed -Usage: alt-focus-hack +Usage: komorebic.exe alt-focus-hack Arguments: @@ -13,4 +13,4 @@ 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 index 937d9f4f..776b5a4d 100644 --- a/docs/cli/application-specific-configuration-schema.md +++ b/docs/cli/application-specific-configuration-schema.md @@ -3,10 +3,10 @@ ``` Generate a JSON Schema for applications.yaml -Usage: application-specific-configuration-schema +Usage: komorebic.exe 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 index 420462da..0d79d194 100644 --- a/docs/cli/change-layout.md +++ b/docs/cli/change-layout.md @@ -3,7 +3,7 @@ ``` Set the layout on the focused workspace -Usage: change-layout +Usage: komorebic.exe change-layout Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/check.md b/docs/cli/check.md index e7d6ead2..bfb9947f 100644 --- a/docs/cli/check.md +++ b/docs/cli/check.md @@ -3,10 +3,10 @@ ``` Output various important komorebi-related environment values -Usage: check +Usage: komorebic.exe check 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 index 6fc947fb..a38f2809 100644 --- a/docs/cli/clear-named-workspace-layout-rules.md +++ b/docs/cli/clear-named-workspace-layout-rules.md @@ -3,7 +3,7 @@ ``` Clear all dynamic layout rules for the specified workspace -Usage: clear-named-workspace-layout-rules +Usage: komorebic.exe clear-named-workspace-layout-rules Arguments: @@ -13,4 +13,4 @@ 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 index 1e3e6ccd..b16aba8e 100644 --- a/docs/cli/clear-workspace-layout-rules.md +++ b/docs/cli/clear-workspace-layout-rules.md @@ -3,7 +3,7 @@ ``` Clear all dynamic layout rules for the specified workspace -Usage: clear-workspace-layout-rules +Usage: komorebic.exe clear-workspace-layout-rules Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/close.md b/docs/cli/close.md index 5133dce2..43e5a8c4 100644 --- a/docs/cli/close.md +++ b/docs/cli/close.md @@ -3,10 +3,10 @@ ``` Close the focused window -Usage: close +Usage: komorebic.exe close Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/complete-configuration.md b/docs/cli/complete-configuration.md index 1ac2d60c..904d7b1d 100644 --- a/docs/cli/complete-configuration.md +++ b/docs/cli/complete-configuration.md @@ -3,10 +3,10 @@ ``` Signal that the final configuration option has been sent -Usage: complete-configuration +Usage: komorebic.exe complete-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 index d20c8a43..6a83f776 100644 --- a/docs/cli/container-padding.md +++ b/docs/cli/container-padding.md @@ -3,7 +3,7 @@ ``` Set the container padding for the specified workspace -Usage: container-padding +Usage: komorebic.exe container-padding Arguments: @@ -19,4 +19,4 @@ 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 index cae3acb3..2a868c44 100644 --- a/docs/cli/cross-monitor-move-behaviour.md +++ b/docs/cli/cross-monitor-move-behaviour.md @@ -3,7 +3,7 @@ ``` Set the behaviour when moving windows across monitor boundaries -Usage: cross-monitor-move-behaviour +Usage: komorebic.exe cross-monitor-move-behaviour Arguments: @@ -15,4 +15,4 @@ Options: -h, --help Print help (see a summary with '-h') -``` \ No newline at end of file +``` diff --git a/docs/cli/cycle-focus.md b/docs/cli/cycle-focus.md index e2a37c7a..da115fd2 100644 --- a/docs/cli/cycle-focus.md +++ b/docs/cli/cycle-focus.md @@ -3,7 +3,7 @@ ``` Change focus to the window in the specified cycle direction -Usage: cycle-focus +Usage: komorebic.exe cycle-focus Arguments: @@ -13,4 +13,4 @@ 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 index c922cadc..6a70f610 100644 --- a/docs/cli/cycle-layout.md +++ b/docs/cli/cycle-layout.md @@ -3,7 +3,7 @@ ``` Cycle between available layouts -Usage: cycle-layout +Usage: komorebic.exe cycle-layout Arguments: @@ -13,4 +13,4 @@ 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 index ce34ea3c..27fccd15 100644 --- a/docs/cli/cycle-monitor.md +++ b/docs/cli/cycle-monitor.md @@ -3,7 +3,7 @@ ``` Focus the monitor in the given cycle direction -Usage: cycle-monitor +Usage: komorebic.exe cycle-monitor Arguments: @@ -13,4 +13,4 @@ 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 index 742dfd04..e6d74b6e 100644 --- a/docs/cli/cycle-move-to-monitor.md +++ b/docs/cli/cycle-move-to-monitor.md @@ -3,7 +3,7 @@ ``` Move the focused window to the monitor in the given cycle direction -Usage: cycle-move-to-monitor +Usage: komorebic.exe cycle-move-to-monitor Arguments: @@ -13,4 +13,4 @@ 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 index a68cae44..2da1a97f 100644 --- a/docs/cli/cycle-move-to-workspace.md +++ b/docs/cli/cycle-move-to-workspace.md @@ -3,7 +3,7 @@ ``` Move the focused window to the workspace in the given cycle direction -Usage: cycle-move-to-workspace +Usage: komorebic.exe cycle-move-to-workspace Arguments: @@ -13,4 +13,4 @@ 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 index dea62fb3..431c6e43 100644 --- a/docs/cli/cycle-move.md +++ b/docs/cli/cycle-move.md @@ -3,7 +3,7 @@ ``` Move the focused window in the specified cycle direction -Usage: cycle-move +Usage: komorebic.exe cycle-move Arguments: @@ -13,4 +13,4 @@ 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 index 22bf5c73..a1795e52 100644 --- a/docs/cli/cycle-send-to-monitor.md +++ b/docs/cli/cycle-send-to-monitor.md @@ -3,7 +3,7 @@ ``` Send the focused window to the monitor in the given cycle direction -Usage: cycle-send-to-monitor +Usage: komorebic.exe cycle-send-to-monitor Arguments: @@ -13,4 +13,4 @@ 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 index 06660744..475c4ddc 100644 --- a/docs/cli/cycle-send-to-workspace.md +++ b/docs/cli/cycle-send-to-workspace.md @@ -3,7 +3,7 @@ ``` Send the focused window to the workspace in the given cycle direction -Usage: cycle-send-to-workspace +Usage: komorebic.exe cycle-send-to-workspace Arguments: @@ -13,4 +13,4 @@ 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 index 40918edc..dbb0a2ac 100644 --- a/docs/cli/cycle-stack.md +++ b/docs/cli/cycle-stack.md @@ -3,7 +3,7 @@ ``` Cycle the focused stack in the specified cycle direction -Usage: cycle-stack +Usage: komorebic.exe cycle-stack Arguments: @@ -13,4 +13,4 @@ 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 index d0a1928c..f388a0b0 100644 --- a/docs/cli/cycle-workspace.md +++ b/docs/cli/cycle-workspace.md @@ -3,7 +3,7 @@ ``` Focus the workspace in the given cycle direction -Usage: cycle-workspace +Usage: komorebic.exe cycle-workspace Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/disable-autostart.md b/docs/cli/disable-autostart.md index 95298453..4272e4eb 100644 --- a/docs/cli/disable-autostart.md +++ b/docs/cli/disable-autostart.md @@ -3,10 +3,10 @@ ``` Deletes the komorebi.lnk shortcut in shell:startup to disable autostart -Usage: disable-autostart +Usage: komorebic.exe disable-autostart 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 index 62ff485b..8c81f672 100644 --- a/docs/cli/display-index-preference.md +++ b/docs/cli/display-index-preference.md @@ -3,7 +3,7 @@ ``` Set the display index preference for a monitor identified using its display name -Usage: display-index-preference +Usage: komorebic.exe display-index-preference Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/docgen.md b/docs/cli/docgen.md new file mode 100644 index 00000000..0333d8b2 --- /dev/null +++ b/docs/cli/docgen.md @@ -0,0 +1,10 @@ +# docgen + +``` +Usage: komorebic.exe docgen + +Options: + -h, --help + Print help + +``` diff --git a/docs/cli/enable-autostart.md b/docs/cli/enable-autostart.md index ca15801d..c04bb84e 100644 --- a/docs/cli/enable-autostart.md +++ b/docs/cli/enable-autostart.md @@ -3,7 +3,7 @@ ``` Generates the komorebi.lnk shortcut in shell:startup to autostart komorebi -Usage: enable-autostart [OPTIONS] +Usage: komorebic.exe enable-autostart [OPTIONS] Options: -c, --config @@ -21,4 +21,4 @@ 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 index 04ec5db2..bb20cdce 100644 --- a/docs/cli/ensure-named-workspaces.md +++ b/docs/cli/ensure-named-workspaces.md @@ -3,7 +3,7 @@ ``` Create these many named workspaces for the specified monitor -Usage: ensure-named-workspaces [NAMES]... +Usage: komorebic.exe ensure-named-workspaces [NAMES]... Arguments: @@ -16,4 +16,4 @@ 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 index 039abe79..990b1847 100644 --- a/docs/cli/ensure-workspaces.md +++ b/docs/cli/ensure-workspaces.md @@ -3,7 +3,7 @@ ``` Create at least this many workspaces for the specified monitor -Usage: ensure-workspaces +Usage: komorebic.exe ensure-workspaces Arguments: @@ -16,4 +16,4 @@ 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 index 7c5e0370..9f607094 100644 --- a/docs/cli/fetch-app-specific-configuration.md +++ b/docs/cli/fetch-app-specific-configuration.md @@ -3,10 +3,10 @@ ``` Fetch the latest version of applications.yaml from komorebi-application-specific-configuration -Usage: fetch-app-specific-configuration +Usage: komorebic.exe 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 index 982ae05e..57d96425 100644 --- a/docs/cli/flip-layout.md +++ b/docs/cli/flip-layout.md @@ -3,7 +3,7 @@ ``` Flip the layout on the focused workspace (BSP only) -Usage: flip-layout +Usage: komorebic.exe flip-layout Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/float-rule.md b/docs/cli/float-rule.md index e51e6c00..2162e30e 100644 --- a/docs/cli/float-rule.md +++ b/docs/cli/float-rule.md @@ -3,7 +3,7 @@ ``` Add a rule to always float the specified application -Usage: float-rule +Usage: komorebic.exe float-rule Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/focus-follows-mouse.md b/docs/cli/focus-follows-mouse.md index e600e2c9..c2e6f74f 100644 --- a/docs/cli/focus-follows-mouse.md +++ b/docs/cli/focus-follows-mouse.md @@ -3,7 +3,7 @@ ``` Enable or disable focus follows mouse for the operating system -Usage: focus-follows-mouse [OPTIONS] +Usage: komorebic.exe focus-follows-mouse [OPTIONS] Arguments: @@ -20,4 +20,4 @@ Options: -h, --help Print help (see a summary with '-h') -``` \ No newline at end of file +``` diff --git a/docs/cli/focus-last-workspace.md b/docs/cli/focus-last-workspace.md index a99ee364..5f22b349 100644 --- a/docs/cli/focus-last-workspace.md +++ b/docs/cli/focus-last-workspace.md @@ -3,10 +3,10 @@ ``` Focus the last focused workspace on the focused monitor -Usage: focus-last-workspace +Usage: komorebic.exe focus-last-workspace 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 index 7fe32a21..28037dcc 100644 --- a/docs/cli/focus-monitor-workspace.md +++ b/docs/cli/focus-monitor-workspace.md @@ -3,7 +3,7 @@ ``` Focus the specified workspace on the target monitor -Usage: focus-monitor-workspace +Usage: komorebic.exe focus-monitor-workspace Arguments: @@ -16,4 +16,4 @@ 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 index 89cdf8fc..6a504f9c 100644 --- a/docs/cli/focus-monitor.md +++ b/docs/cli/focus-monitor.md @@ -3,7 +3,7 @@ ``` Focus the specified monitor -Usage: focus-monitor +Usage: komorebic.exe focus-monitor Arguments: @@ -13,4 +13,4 @@ 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 index 397ae16c..3180e9de 100644 --- a/docs/cli/focus-named-workspace.md +++ b/docs/cli/focus-named-workspace.md @@ -3,7 +3,7 @@ ``` Focus the specified workspace -Usage: focus-named-workspace +Usage: komorebic.exe focus-named-workspace Arguments: @@ -13,4 +13,4 @@ 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 index 0d3ffaaa..a136513e 100644 --- a/docs/cli/focus-workspace.md +++ b/docs/cli/focus-workspace.md @@ -3,7 +3,7 @@ ``` Focus the specified workspace on the focused monitor -Usage: focus-workspace +Usage: komorebic.exe focus-workspace Arguments: @@ -13,4 +13,4 @@ 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 index 88bec515..d5c606ea 100644 --- a/docs/cli/focus-workspaces.md +++ b/docs/cli/focus-workspaces.md @@ -3,7 +3,7 @@ ``` Focus the specified workspace on all monitors -Usage: focus-workspaces +Usage: komorebic.exe focus-workspaces Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/focus.md b/docs/cli/focus.md index 0ecb697d..80600d55 100644 --- a/docs/cli/focus.md +++ b/docs/cli/focus.md @@ -3,7 +3,7 @@ ``` Change focus to the window in the specified direction -Usage: focus +Usage: komorebic.exe focus Arguments: @@ -13,4 +13,4 @@ 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 index 5ff6219f..df9460dc 100644 --- a/docs/cli/focused-workspace-container-padding.md +++ b/docs/cli/focused-workspace-container-padding.md @@ -3,7 +3,7 @@ ``` Set container padding on the focused workspace -Usage: focused-workspace-container-padding +Usage: komorebic.exe focused-workspace-container-padding Arguments: @@ -13,4 +13,4 @@ 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 index 01e17c7d..76abb615 100644 --- a/docs/cli/focused-workspace-padding.md +++ b/docs/cli/focused-workspace-padding.md @@ -3,7 +3,7 @@ ``` Set workspace padding on the focused workspace -Usage: focused-workspace-padding +Usage: komorebic.exe focused-workspace-padding Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/force-focus.md b/docs/cli/force-focus.md index 6892cfb6..cf97b6e5 100644 --- a/docs/cli/force-focus.md +++ b/docs/cli/force-focus.md @@ -3,10 +3,10 @@ ``` Forcibly focus the window at the cursor with a left mouse click -Usage: force-focus +Usage: komorebic.exe force-focus Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/format-app-specific-configuration.md b/docs/cli/format-app-specific-configuration.md index 5ef7d093..8cb3c42a 100644 --- a/docs/cli/format-app-specific-configuration.md +++ b/docs/cli/format-app-specific-configuration.md @@ -3,7 +3,7 @@ ``` Format a YAML file for use with the 'ahk-app-specific-configuration' command -Usage: format-app-specific-configuration +Usage: komorebic.exe format-app-specific-configuration Arguments: @@ -13,4 +13,4 @@ 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 index 91515093..e850c06e 100644 --- a/docs/cli/generate-static-config.md +++ b/docs/cli/generate-static-config.md @@ -3,10 +3,10 @@ ``` Generates a static configuration JSON file based on the current window manager state -Usage: generate-static-config +Usage: komorebic.exe generate-static-config 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 index f90e52ad..75365f0e 100644 --- a/docs/cli/global-work-area-offset.md +++ b/docs/cli/global-work-area-offset.md @@ -3,7 +3,7 @@ ``` Set offsets to exclude parts of the work area from tiling -Usage: global-work-area-offset +Usage: komorebic.exe global-work-area-offset Arguments: @@ -22,4 +22,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/identify-border-overflow-application.md b/docs/cli/identify-border-overflow-application.md index 1fa0c1b1..932e8cfc 100644 --- a/docs/cli/identify-border-overflow-application.md +++ b/docs/cli/identify-border-overflow-application.md @@ -3,7 +3,7 @@ ``` Identify an application that has overflowing borders -Usage: identify-border-overflow-application +Usage: komorebic.exe identify-border-overflow-application Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/identify-layered-application.md b/docs/cli/identify-layered-application.md index aa996888..0c8e2d7c 100644 --- a/docs/cli/identify-layered-application.md +++ b/docs/cli/identify-layered-application.md @@ -3,7 +3,7 @@ ``` Identify an application that has WS_EX_LAYERED, but should still be managed -Usage: identify-layered-application +Usage: komorebic.exe identify-layered-application Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/identify-object-name-change-application.md b/docs/cli/identify-object-name-change-application.md index b994f731..90221e61 100644 --- a/docs/cli/identify-object-name-change-application.md +++ b/docs/cli/identify-object-name-change-application.md @@ -3,7 +3,7 @@ ``` Identify an application that sends EVENT_OBJECT_NAMECHANGE on launch -Usage: identify-object-name-change-application +Usage: komorebic.exe identify-object-name-change-application Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/identify-tray-application.md b/docs/cli/identify-tray-application.md index a933c0d5..83bed71b 100644 --- a/docs/cli/identify-tray-application.md +++ b/docs/cli/identify-tray-application.md @@ -3,7 +3,7 @@ ``` Identify an application that closes to the system tray -Usage: identify-tray-application +Usage: komorebic.exe identify-tray-application Arguments: @@ -16,4 +16,4 @@ 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 index d4a11cfc..a8cab6a0 100644 --- a/docs/cli/initial-named-workspace-rule.md +++ b/docs/cli/initial-named-workspace-rule.md @@ -3,7 +3,7 @@ ``` Add a rule to associate an application with a named workspace on first show -Usage: initial-named-workspace-rule +Usage: komorebic.exe initial-named-workspace-rule Arguments: @@ -19,4 +19,4 @@ 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 index b5a1c142..4e416593 100644 --- a/docs/cli/initial-workspace-rule.md +++ b/docs/cli/initial-workspace-rule.md @@ -3,7 +3,7 @@ ``` Add a rule to associate an application with a workspace on first show -Usage: initial-workspace-rule +Usage: komorebic.exe initial-workspace-rule Arguments: @@ -22,4 +22,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/invisible-borders.md b/docs/cli/invisible-borders.md index ecfc18ba..ba0f948d 100644 --- a/docs/cli/invisible-borders.md +++ b/docs/cli/invisible-borders.md @@ -3,7 +3,7 @@ ``` Set the invisible border dimensions around each window -Usage: invisible-borders +Usage: komorebic.exe invisible-borders Arguments: @@ -22,4 +22,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/load-custom-layout.md b/docs/cli/load-custom-layout.md index 4e4e3012..de5e9554 100644 --- a/docs/cli/load-custom-layout.md +++ b/docs/cli/load-custom-layout.md @@ -3,7 +3,7 @@ ``` Load a custom layout from file for the focused workspace -Usage: load-custom-layout +Usage: komorebic.exe load-custom-layout Arguments: @@ -13,4 +13,4 @@ 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 index 84d554aa..975ac5ef 100644 --- a/docs/cli/load-resize.md +++ b/docs/cli/load-resize.md @@ -3,7 +3,7 @@ ``` Load the resize layout dimensions from a file -Usage: load-resize +Usage: komorebic.exe load-resize Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/log.md b/docs/cli/log.md index 450c4a1f..f2d645a0 100644 --- a/docs/cli/log.md +++ b/docs/cli/log.md @@ -3,10 +3,10 @@ ``` Tail komorebi.exe's process logs (cancel with Ctrl-C) -Usage: log +Usage: komorebic.exe 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 index 80322308..ee4ce3a1 100644 --- a/docs/cli/manage-rule.md +++ b/docs/cli/manage-rule.md @@ -3,7 +3,7 @@ ``` Add a rule to always manage the specified application -Usage: manage-rule +Usage: komorebic.exe manage-rule Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/manage.md b/docs/cli/manage.md index 3825e3b2..6a0f6d3b 100644 --- a/docs/cli/manage.md +++ b/docs/cli/manage.md @@ -3,10 +3,10 @@ ``` Force komorebi to manage the focused window -Usage: manage +Usage: komorebic.exe manage Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/minimize.md b/docs/cli/minimize.md index 92da0f53..c77c1dd7 100644 --- a/docs/cli/minimize.md +++ b/docs/cli/minimize.md @@ -3,10 +3,10 @@ ``` Minimize the focused window -Usage: minimize +Usage: komorebic.exe minimize Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/monitor-index-preference.md b/docs/cli/monitor-index-preference.md index e6ea66a3..ad0f02ac 100644 --- a/docs/cli/monitor-index-preference.md +++ b/docs/cli/monitor-index-preference.md @@ -3,7 +3,7 @@ ``` Set the monitor index preference for a monitor identified using its size -Usage: monitor-index-preference +Usage: komorebic.exe monitor-index-preference Arguments: @@ -25,4 +25,4 @@ 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 index 99324363..d8f45034 100644 --- a/docs/cli/monitor-work-area-offset.md +++ b/docs/cli/monitor-work-area-offset.md @@ -3,7 +3,7 @@ ``` Set offsets for a monitor to exclude parts of the work area from tiling -Usage: monitor-work-area-offset +Usage: komorebic.exe monitor-work-area-offset Arguments: @@ -25,4 +25,4 @@ 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 index a5fbf194..ce0942b9 100644 --- a/docs/cli/mouse-follows-focus.md +++ b/docs/cli/mouse-follows-focus.md @@ -3,7 +3,7 @@ ``` Enable or disable mouse follows focus on all workspaces -Usage: mouse-follows-focus +Usage: komorebic.exe mouse-follows-focus Arguments: @@ -13,4 +13,4 @@ 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 index 75be72f7..121e4365 100644 --- a/docs/cli/move-to-monitor.md +++ b/docs/cli/move-to-monitor.md @@ -3,7 +3,7 @@ ``` Move the focused window to the specified monitor -Usage: move-to-monitor +Usage: komorebic.exe move-to-monitor Arguments: @@ -13,4 +13,4 @@ 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 index 22f4d262..ae8dca91 100644 --- a/docs/cli/move-to-named-workspace.md +++ b/docs/cli/move-to-named-workspace.md @@ -3,7 +3,7 @@ ``` Move the focused window to the specified workspace -Usage: move-to-named-workspace +Usage: komorebic.exe move-to-named-workspace Arguments: @@ -13,4 +13,4 @@ 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 index 8206083b..29492515 100644 --- a/docs/cli/move-to-workspace.md +++ b/docs/cli/move-to-workspace.md @@ -3,7 +3,7 @@ ``` Move the focused window to the specified workspace -Usage: move-to-workspace +Usage: komorebic.exe move-to-workspace Arguments: @@ -13,4 +13,4 @@ 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 index 1dab0119..0d7c38f1 100644 --- a/docs/cli/move-workspace-to-monitor.md +++ b/docs/cli/move-workspace-to-monitor.md @@ -3,7 +3,7 @@ ``` Move the focused workspace to the specified monitor -Usage: move-workspace-to-monitor +Usage: komorebic.exe move-workspace-to-monitor Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/move.md b/docs/cli/move.md index 52c9b360..633eb2ea 100644 --- a/docs/cli/move.md +++ b/docs/cli/move.md @@ -3,7 +3,7 @@ ``` Move the focused window in the specified direction -Usage: move +Usage: komorebic.exe move Arguments: @@ -13,4 +13,4 @@ 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 index b8849eb9..ca861872 100644 --- a/docs/cli/named-workspace-container-padding.md +++ b/docs/cli/named-workspace-container-padding.md @@ -3,7 +3,7 @@ ``` Set the container padding for the specified workspace -Usage: named-workspace-container-padding +Usage: komorebic.exe named-workspace-container-padding Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/named-workspace-custom-layout-rule.md b/docs/cli/named-workspace-custom-layout-rule.md index 1fb38815..afcb5e97 100644 --- a/docs/cli/named-workspace-custom-layout-rule.md +++ b/docs/cli/named-workspace-custom-layout-rule.md @@ -3,7 +3,7 @@ ``` Add a dynamic custom layout for the specified workspace -Usage: named-workspace-custom-layout-rule +Usage: komorebic.exe named-workspace-custom-layout-rule Arguments: @@ -19,4 +19,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/named-workspace-custom-layout.md b/docs/cli/named-workspace-custom-layout.md index 2a53c9d5..e7942151 100644 --- a/docs/cli/named-workspace-custom-layout.md +++ b/docs/cli/named-workspace-custom-layout.md @@ -3,7 +3,7 @@ ``` Set a custom layout for the specified workspace -Usage: named-workspace-custom-layout +Usage: komorebic.exe named-workspace-custom-layout Arguments: @@ -16,4 +16,4 @@ 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 index 7abf82b6..407f70cd 100644 --- a/docs/cli/named-workspace-layout-rule.md +++ b/docs/cli/named-workspace-layout-rule.md @@ -3,7 +3,7 @@ ``` Add a dynamic layout rule for the specified workspace -Usage: named-workspace-layout-rule +Usage: komorebic.exe named-workspace-layout-rule Arguments: @@ -19,4 +19,4 @@ 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 index 6a74f770..aad5b396 100644 --- a/docs/cli/named-workspace-layout.md +++ b/docs/cli/named-workspace-layout.md @@ -3,7 +3,7 @@ ``` Set the layout for the specified workspace -Usage: named-workspace-layout +Usage: komorebic.exe named-workspace-layout Arguments: @@ -16,4 +16,4 @@ 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 index 7f0331c1..c9516782 100644 --- a/docs/cli/named-workspace-padding.md +++ b/docs/cli/named-workspace-padding.md @@ -3,7 +3,7 @@ ``` Set the workspace padding for the specified workspace -Usage: named-workspace-padding +Usage: komorebic.exe named-workspace-padding Arguments: @@ -16,4 +16,4 @@ 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 index 1dfd67d3..9837563c 100644 --- a/docs/cli/named-workspace-rule.md +++ b/docs/cli/named-workspace-rule.md @@ -3,7 +3,7 @@ ``` Add a rule to associate an application with a named workspace -Usage: named-workspace-rule +Usage: komorebic.exe named-workspace-rule Arguments: @@ -19,4 +19,4 @@ 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 index b82d6363..d8960e43 100644 --- a/docs/cli/named-workspace-tiling.md +++ b/docs/cli/named-workspace-tiling.md @@ -3,7 +3,7 @@ ``` Enable or disable window tiling for the specified workspace -Usage: named-workspace-tiling +Usage: komorebic.exe named-workspace-tiling Arguments: @@ -16,4 +16,4 @@ 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 index 8bac4ad4..46793a03 100644 --- a/docs/cli/new-workspace.md +++ b/docs/cli/new-workspace.md @@ -3,10 +3,10 @@ ``` Create and append a new workspace on the focused monitor -Usage: new-workspace +Usage: komorebic.exe 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 index a3b8bc28..3d38355a 100644 --- a/docs/cli/notification-schema.md +++ b/docs/cli/notification-schema.md @@ -3,10 +3,10 @@ ``` Generate a JSON Schema of subscription notifications -Usage: notification-schema +Usage: komorebic.exe 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 index 82b8d1e3..3457fc41 100644 --- a/docs/cli/promote-focus.md +++ b/docs/cli/promote-focus.md @@ -3,10 +3,10 @@ ``` Promote the user focus to the top of the tree -Usage: promote-focus +Usage: komorebic.exe promote-focus Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/promote.md b/docs/cli/promote.md index f2cbe1f0..b40d299c 100644 --- a/docs/cli/promote.md +++ b/docs/cli/promote.md @@ -3,10 +3,10 @@ ``` Promote the focused window to the top of the tree -Usage: promote +Usage: komorebic.exe promote Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/pwsh-app-specific-configuration.md b/docs/cli/pwsh-app-specific-configuration.md index 090a0e4a..82d7f904 100644 --- a/docs/cli/pwsh-app-specific-configuration.md +++ b/docs/cli/pwsh-app-specific-configuration.md @@ -3,7 +3,7 @@ ``` Generate common app-specific configurations and fixes in a PowerShell script -Usage: pwsh-app-specific-configuration [OVERRIDE_PATH] +Usage: komorebic.exe pwsh-app-specific-configuration [OVERRIDE_PATH] Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/query.md b/docs/cli/query.md index 753af301..58203b62 100644 --- a/docs/cli/query.md +++ b/docs/cli/query.md @@ -3,7 +3,7 @@ ``` Query the current window manager state -Usage: query +Usage: komorebic.exe query Arguments: @@ -13,4 +13,4 @@ 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 index 1db0cd9b..a053b5f9 100644 --- a/docs/cli/quick-load-resize.md +++ b/docs/cli/quick-load-resize.md @@ -3,10 +3,10 @@ ``` Load the last quicksaved resize layout dimensions -Usage: quick-load-resize +Usage: komorebic.exe 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 index f2fe06e0..390a1401 100644 --- a/docs/cli/quick-save-resize.md +++ b/docs/cli/quick-save-resize.md @@ -3,10 +3,10 @@ ``` Quicksave the current resize layout dimensions -Usage: quick-save-resize +Usage: komorebic.exe quick-save-resize Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/quickstart.md b/docs/cli/quickstart.md index db8d5fef..05f45f48 100644 --- a/docs/cli/quickstart.md +++ b/docs/cli/quickstart.md @@ -3,10 +3,10 @@ ``` Gather example configurations for a new-user quickstart -Usage: quickstart +Usage: komorebic.exe quickstart Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/reload-configuration.md b/docs/cli/reload-configuration.md index b40a2c33..1dd636ce 100644 --- a/docs/cli/reload-configuration.md +++ b/docs/cli/reload-configuration.md @@ -3,10 +3,10 @@ ``` Reload ~/komorebi.ahk (if it exists) -Usage: reload-configuration +Usage: komorebic.exe reload-configuration Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/remove-title-bar.md b/docs/cli/remove-title-bar.md index 4edd20d8..ada7de88 100644 --- a/docs/cli/remove-title-bar.md +++ b/docs/cli/remove-title-bar.md @@ -3,7 +3,7 @@ ``` Whitelist an application for title bar removal -Usage: remove-title-bar +Usage: komorebic.exe remove-title-bar Arguments: @@ -16,4 +16,4 @@ 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 index af2836b6..8d8a39a9 100644 --- a/docs/cli/resize-axis.md +++ b/docs/cli/resize-axis.md @@ -3,7 +3,7 @@ ``` Resize the focused window or primary column along the specified axis -Usage: resize-axis +Usage: komorebic.exe resize-axis Arguments: @@ -16,4 +16,4 @@ 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 index 197af9d2..9b7299f0 100644 --- a/docs/cli/resize-delta.md +++ b/docs/cli/resize-delta.md @@ -3,7 +3,7 @@ ``` Set the resize delta (used by resize-edge and resize-axis) -Usage: resize-delta +Usage: komorebic.exe resize-delta Arguments: @@ -13,4 +13,4 @@ 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 index dbe59d99..c2de22f9 100644 --- a/docs/cli/resize-edge.md +++ b/docs/cli/resize-edge.md @@ -3,7 +3,7 @@ ``` Resize the focused window in the specified direction -Usage: resize-edge +Usage: komorebic.exe resize-edge Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/restore-windows.md b/docs/cli/restore-windows.md index e34b98c7..9c020b13 100644 --- a/docs/cli/restore-windows.md +++ b/docs/cli/restore-windows.md @@ -3,10 +3,10 @@ ``` Restore all hidden windows (debugging command) -Usage: restore-windows +Usage: komorebic.exe restore-windows Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/retile.md b/docs/cli/retile.md index 16a6f46a..34396aba 100644 --- a/docs/cli/retile.md +++ b/docs/cli/retile.md @@ -3,10 +3,10 @@ ``` Force the retiling of all managed windows -Usage: retile +Usage: komorebic.exe 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 index 9a7e7671..cc157d05 100644 --- a/docs/cli/save-resize.md +++ b/docs/cli/save-resize.md @@ -3,7 +3,7 @@ ``` Save the current resize layout dimensions to a file -Usage: save-resize +Usage: komorebic.exe save-resize Arguments: @@ -13,4 +13,4 @@ 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 index 48072f08..7350d080 100644 --- a/docs/cli/send-to-monitor-workspace.md +++ b/docs/cli/send-to-monitor-workspace.md @@ -3,7 +3,7 @@ ``` Send the focused window to the specified monitor workspace -Usage: send-to-monitor-workspace +Usage: komorebic.exe send-to-monitor-workspace Arguments: @@ -16,4 +16,4 @@ 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 index 3bce5720..5bd4120b 100644 --- a/docs/cli/send-to-monitor.md +++ b/docs/cli/send-to-monitor.md @@ -3,7 +3,7 @@ ``` Send the focused window to the specified monitor -Usage: send-to-monitor +Usage: komorebic.exe send-to-monitor Arguments: @@ -13,4 +13,4 @@ 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 index 1349f676..693a6da4 100644 --- a/docs/cli/send-to-named-workspace.md +++ b/docs/cli/send-to-named-workspace.md @@ -3,7 +3,7 @@ ``` Send the focused window to the specified workspace -Usage: send-to-named-workspace +Usage: komorebic.exe send-to-named-workspace Arguments: @@ -13,4 +13,4 @@ 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 index 9d5660db..dfc2ac46 100644 --- a/docs/cli/send-to-workspace.md +++ b/docs/cli/send-to-workspace.md @@ -3,7 +3,7 @@ ``` Send the focused window to the specified workspace -Usage: send-to-workspace +Usage: komorebic.exe send-to-workspace Arguments: @@ -13,4 +13,4 @@ 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 index 473dd4f9..cb521a87 100644 --- a/docs/cli/socket-schema.md +++ b/docs/cli/socket-schema.md @@ -3,10 +3,10 @@ ``` Generate a JSON Schema of socket messages -Usage: socket-schema +Usage: komorebic.exe socket-schema Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/stack.md b/docs/cli/stack.md index 5a4e85bc..1f9d8ab1 100644 --- a/docs/cli/stack.md +++ b/docs/cli/stack.md @@ -3,7 +3,7 @@ ``` Stack the focused window in the specified direction -Usage: stack +Usage: komorebic.exe stack Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/start.md b/docs/cli/start.md index 859cc9e9..a5e17c55 100644 --- a/docs/cli/start.md +++ b/docs/cli/start.md @@ -3,7 +3,7 @@ ``` Start komorebi.exe as a background process -Usage: start [OPTIONS] +Usage: komorebic.exe start [OPTIONS] Options: -f, --ffm @@ -27,4 +27,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/state.md b/docs/cli/state.md index f55095e6..a38ced17 100644 --- a/docs/cli/state.md +++ b/docs/cli/state.md @@ -3,10 +3,10 @@ ``` Show a JSON representation of the current window manager state -Usage: state +Usage: komorebic.exe 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 index 68af2c62..ebc82e76 100644 --- a/docs/cli/static-config-schema.md +++ b/docs/cli/static-config-schema.md @@ -3,10 +3,10 @@ ``` Generate a JSON Schema of the static configuration file -Usage: static-config-schema +Usage: komorebic.exe 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 index 71206d4c..11d42589 100644 --- a/docs/cli/stop.md +++ b/docs/cli/stop.md @@ -3,7 +3,7 @@ ``` Stop the komorebi.exe process and restore all hidden windows -Usage: stop [OPTIONS] +Usage: komorebic.exe stop [OPTIONS] Options: --whkd @@ -12,4 +12,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/subscribe.md b/docs/cli/subscribe.md index 14f59428..04eccac4 100644 --- a/docs/cli/subscribe.md +++ b/docs/cli/subscribe.md @@ -3,7 +3,7 @@ ``` Subscribe to komorebi events -Usage: subscribe +Usage: komorebic.exe subscribe Arguments: @@ -13,4 +13,4 @@ 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 index cb271e76..0ba798bf 100644 --- a/docs/cli/swap-workspaces-with-monitor.md +++ b/docs/cli/swap-workspaces-with-monitor.md @@ -3,7 +3,7 @@ ``` Swap focused monitor workspaces with specified monitor -Usage: swap-workspaces-with-monitor +Usage: komorebic.exe swap-workspaces-with-monitor Arguments: @@ -13,4 +13,4 @@ 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 index f1a4c771..1601dee3 100644 --- a/docs/cli/toggle-cross-monitor-move-behaviour.md +++ b/docs/cli/toggle-cross-monitor-move-behaviour.md @@ -3,10 +3,10 @@ ``` Toggle the behaviour when moving windows across monitor boundaries -Usage: toggle-cross-monitor-move-behaviour +Usage: komorebic.exe toggle-cross-monitor-move-behaviour 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 index c8aaf219..186ef594 100644 --- a/docs/cli/toggle-float.md +++ b/docs/cli/toggle-float.md @@ -3,10 +3,10 @@ ``` Toggle floating mode for the focused window -Usage: toggle-float +Usage: komorebic.exe toggle-float Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/toggle-focus-follows-mouse.md b/docs/cli/toggle-focus-follows-mouse.md index 509b3a6b..80e448b7 100644 --- a/docs/cli/toggle-focus-follows-mouse.md +++ b/docs/cli/toggle-focus-follows-mouse.md @@ -3,7 +3,7 @@ ``` Toggle focus follows mouse for the operating system -Usage: toggle-focus-follows-mouse [OPTIONS] +Usage: komorebic.exe toggle-focus-follows-mouse [OPTIONS] Options: -i, --implementation @@ -16,4 +16,4 @@ Options: -h, --help Print help (see a summary with '-h') -``` \ No newline at end of file +``` diff --git a/docs/cli/toggle-maximize.md b/docs/cli/toggle-maximize.md index 64eeceac..a2772aa1 100644 --- a/docs/cli/toggle-maximize.md +++ b/docs/cli/toggle-maximize.md @@ -3,10 +3,10 @@ ``` Toggle native maximization for the focused window -Usage: toggle-maximize +Usage: komorebic.exe toggle-maximize 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 index b4901603..1f3bf31a 100644 --- a/docs/cli/toggle-monocle.md +++ b/docs/cli/toggle-monocle.md @@ -3,10 +3,10 @@ ``` Toggle monocle mode for the focused container -Usage: toggle-monocle +Usage: komorebic.exe 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 index 85c6199f..a97d1493 100644 --- a/docs/cli/toggle-mouse-follows-focus.md +++ b/docs/cli/toggle-mouse-follows-focus.md @@ -3,10 +3,10 @@ ``` Toggle mouse follows focus on all workspaces -Usage: toggle-mouse-follows-focus +Usage: komorebic.exe 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 index b8c5c858..3024b095 100644 --- a/docs/cli/toggle-pause.md +++ b/docs/cli/toggle-pause.md @@ -3,10 +3,10 @@ ``` Toggle window tiling on the focused workspace -Usage: toggle-pause +Usage: komorebic.exe 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 index fcbb7ef4..6ff72ab6 100644 --- a/docs/cli/toggle-tiling.md +++ b/docs/cli/toggle-tiling.md @@ -3,10 +3,10 @@ ``` Toggle window tiling on the focused workspace -Usage: toggle-tiling +Usage: komorebic.exe toggle-tiling Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/toggle-title-bars.md b/docs/cli/toggle-title-bars.md index 81100033..4ba04ac4 100644 --- a/docs/cli/toggle-title-bars.md +++ b/docs/cli/toggle-title-bars.md @@ -3,10 +3,10 @@ ``` Toggle title bars for whitelisted applications -Usage: toggle-title-bars +Usage: komorebic.exe toggle-title-bars 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 index b9f2ec00..e7175c4e 100644 --- a/docs/cli/toggle-window-container-behaviour.md +++ b/docs/cli/toggle-window-container-behaviour.md @@ -3,10 +3,10 @@ ``` Toggle the behaviour for new windows (stacking or dynamic tiling) -Usage: toggle-window-container-behaviour +Usage: komorebic.exe toggle-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 index dc4bba6c..2ca4148f 100644 --- a/docs/cli/unmanage.md +++ b/docs/cli/unmanage.md @@ -3,10 +3,10 @@ ``` Unmanage a window that was forcibly managed -Usage: unmanage +Usage: komorebic.exe 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 index 48a011bc..c665ae88 100644 --- a/docs/cli/unmanaged-window-operation-behaviour.md +++ b/docs/cli/unmanaged-window-operation-behaviour.md @@ -3,7 +3,7 @@ ``` Set the operation behaviour when the focused window is not managed -Usage: unmanaged-window-operation-behaviour +Usage: komorebic.exe unmanaged-window-operation-behaviour Arguments: @@ -15,4 +15,4 @@ Options: -h, --help Print help (see a summary with '-h') -``` \ No newline at end of file +``` diff --git a/docs/cli/unstack.md b/docs/cli/unstack.md index 437409db..b720cc77 100644 --- a/docs/cli/unstack.md +++ b/docs/cli/unstack.md @@ -3,10 +3,10 @@ ``` Unstack the focused window -Usage: unstack +Usage: komorebic.exe unstack Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/unsubscribe.md b/docs/cli/unsubscribe.md index ebdaa8d2..a10b1e90 100644 --- a/docs/cli/unsubscribe.md +++ b/docs/cli/unsubscribe.md @@ -3,7 +3,7 @@ ``` Unsubscribe from komorebi events -Usage: unsubscribe +Usage: komorebic.exe unsubscribe Arguments: @@ -13,4 +13,4 @@ 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 index 9607d34a..293f7624 100644 --- a/docs/cli/visible-windows.md +++ b/docs/cli/visible-windows.md @@ -3,10 +3,10 @@ ``` Show a JSON representation of visible windows -Usage: visible-windows +Usage: komorebic.exe visible-windows Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/watch-configuration.md b/docs/cli/watch-configuration.md index a973cb12..40d5fda9 100644 --- a/docs/cli/watch-configuration.md +++ b/docs/cli/watch-configuration.md @@ -3,7 +3,7 @@ ``` Enable or disable watching of ~/komorebi.ahk (if it exists) -Usage: watch-configuration +Usage: komorebic.exe watch-configuration Arguments: @@ -13,4 +13,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/window-hiding-behaviour.md b/docs/cli/window-hiding-behaviour.md index 2f3123d4..8071dae3 100644 --- a/docs/cli/window-hiding-behaviour.md +++ b/docs/cli/window-hiding-behaviour.md @@ -3,7 +3,7 @@ ``` Set the window behaviour when switching workspaces / cycling stacks -Usage: window-hiding-behaviour +Usage: komorebic.exe window-hiding-behaviour Arguments: @@ -16,4 +16,4 @@ Options: -h, --help Print help (see a summary with '-h') -``` \ No newline at end of file +``` diff --git a/docs/cli/workspace-custom-layout-rule.md b/docs/cli/workspace-custom-layout-rule.md index a2ed0e08..611d62e0 100644 --- a/docs/cli/workspace-custom-layout-rule.md +++ b/docs/cli/workspace-custom-layout-rule.md @@ -3,7 +3,7 @@ ``` Add a dynamic custom layout for the specified workspace -Usage: workspace-custom-layout-rule +Usage: komorebic.exe workspace-custom-layout-rule Arguments: @@ -22,4 +22,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/cli/workspace-custom-layout.md b/docs/cli/workspace-custom-layout.md index 86455cc0..69b33350 100644 --- a/docs/cli/workspace-custom-layout.md +++ b/docs/cli/workspace-custom-layout.md @@ -3,7 +3,7 @@ ``` Set a custom layout for the specified workspace -Usage: workspace-custom-layout +Usage: komorebic.exe workspace-custom-layout Arguments: @@ -19,4 +19,4 @@ 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 index 95880375..7fe7b7a8 100644 --- a/docs/cli/workspace-layout-rule.md +++ b/docs/cli/workspace-layout-rule.md @@ -3,7 +3,7 @@ ``` Add a dynamic layout rule for the specified workspace -Usage: workspace-layout-rule +Usage: komorebic.exe workspace-layout-rule Arguments: @@ -22,4 +22,4 @@ 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 index 560bbe2f..a5d05cd8 100644 --- a/docs/cli/workspace-layout.md +++ b/docs/cli/workspace-layout.md @@ -3,7 +3,7 @@ ``` Set the layout for the specified workspace -Usage: workspace-layout +Usage: komorebic.exe workspace-layout Arguments: @@ -19,4 +19,4 @@ 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 index 4f0fe9f8..41b3de89 100644 --- a/docs/cli/workspace-name.md +++ b/docs/cli/workspace-name.md @@ -3,7 +3,7 @@ ``` Set the workspace name for the specified workspace -Usage: workspace-name +Usage: komorebic.exe workspace-name Arguments: @@ -19,4 +19,4 @@ 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 index 1ecbbf3e..252567a3 100644 --- a/docs/cli/workspace-padding.md +++ b/docs/cli/workspace-padding.md @@ -3,7 +3,7 @@ ``` Set the workspace padding for the specified workspace -Usage: workspace-padding +Usage: komorebic.exe workspace-padding Arguments: @@ -19,4 +19,4 @@ 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 index e4d2e329..24912a2e 100644 --- a/docs/cli/workspace-rule.md +++ b/docs/cli/workspace-rule.md @@ -3,7 +3,7 @@ ``` Add a rule to associate an application with a workspace -Usage: workspace-rule +Usage: komorebic.exe workspace-rule Arguments: @@ -22,4 +22,4 @@ 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 index 9816e7f9..f62f2b70 100644 --- a/docs/cli/workspace-tiling.md +++ b/docs/cli/workspace-tiling.md @@ -3,7 +3,7 @@ ``` Enable or disable window tiling for the specified workspace -Usage: workspace-tiling +Usage: komorebic.exe workspace-tiling Arguments: @@ -19,4 +19,4 @@ Options: -h, --help Print help -``` \ No newline at end of file +``` diff --git a/docs/installation.md b/docs/installation.md index 5113411e..3d40ae9b 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -30,9 +30,9 @@ to manipulate the window manager, you use [WinGet](https://winget.run/pkg/LGUG2Z/komorebi), and you may also built it from [source](https://github.com/LGUG2Z/komorebi) if you would prefer. - - [Scoop](install/scoop.md) - - [WinGet](install/winget.md) - - [Build from source](install/source.md) + - [Scoop](#scoop) + - [WinGet](#winget) + - [Building from source](#building-from-source) ## Long path support @@ -69,7 +69,7 @@ scoop install komorebi whkd ``` Once komorebi is installed, proceed to get the [example -configurations](./example-configurations). +configurations](example-configurations.md). ## WinGet @@ -93,7 +93,7 @@ winget install LGUG2Z.whkd ``` Once komorebi is installed, proceed to get the [example -configurations](./example-configurations). +configurations](example-configurations.md). ## Building from source diff --git a/justfile b/justfile index 30de3cca..6d98bf9e 100644 --- a/justfile +++ b/justfile @@ -46,3 +46,7 @@ trace $RUST_LOG="trace": deadlock $RUST_LOG="trace": just install-komorebic cargo +stable run --bin komorebi --locked --features deadlock_detection + +docgen: + komorebic docgen + Get-ChildItem -Path "docs/cli" -Recurse -File | ForEach-Object { (Get-Content $_.FullName) -replace 'Usage: ', 'Usage: komorebic.exe ' | Set-Content $_.FullName } diff --git a/mkdocs.yml b/mkdocs.yml index 3a372082..dbedc3c3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -41,6 +41,7 @@ theme: - toc.follow plugins: - macros + - search nav: - Komorebi: @@ -49,3 +50,137 @@ nav: - Getting started: - Installation: installation.md - Example configurations: example-configurations.md + - CLI reference: + - cli/quickstart.md + - cli/start.md + - cli/stop.md + - cli/check.md + - cli/state.md + - cli/visible-windows.md + - cli/query.md + - cli/subscribe.md + - cli/unsubscribe.md + - cli/log.md + - cli/quick-save-resize.md + - cli/quick-load-resize.md + - cli/save-resize.md + - cli/load-resize.md + - cli/focus.md + - cli/move.md + - cli/minimize.md + - cli/close.md + - cli/force-focus.md + - cli/cycle-focus.md + - cli/cycle-move.md + - cli/stack.md + - cli/resize-edge.md + - cli/resize-axis.md + - cli/unstack.md + - cli/cycle-stack.md + - cli/move-to-monitor.md + - cli/cycle-move-to-monitor.md + - cli/move-to-workspace.md + - cli/move-to-named-workspace.md + - cli/cycle-move-to-workspace.md + - cli/send-to-monitor.md + - cli/cycle-send-to-monitor.md + - cli/send-to-workspace.md + - cli/send-to-named-workspace.md + - cli/cycle-send-to-workspace.md + - cli/send-to-monitor-workspace.md + - cli/focus-monitor.md + - cli/focus-last-workspace.md + - cli/focus-workspace.md + - cli/focus-workspaces.md + - cli/focus-monitor-workspace.md + - cli/focus-named-workspace.md + - cli/cycle-monitor.md + - cli/cycle-workspace.md + - cli/move-workspace-to-monitor.md + - cli/swap-workspaces-with-monitor.md + - cli/new-workspace.md + - cli/resize-delta.md + - cli/invisible-borders.md + - cli/global-work-area-offset.md + - cli/monitor-work-area-offset.md + - cli/focused-workspace-container-padding.md + - cli/focused-workspace-padding.md + - cli/adjust-container-padding.md + - cli/adjust-workspace-padding.md + - cli/change-layout.md + - cli/cycle-layout.md + - cli/load-custom-layout.md + - cli/flip-layout.md + - cli/promote.md + - cli/promote-focus.md + - cli/retile.md + - cli/monitor-index-preference.md + - cli/display-index-preference.md + - cli/ensure-workspaces.md + - cli/ensure-named-workspaces.md + - cli/container-padding.md + - cli/named-workspace-container-padding.md + - cli/workspace-padding.md + - cli/named-workspace-padding.md + - cli/workspace-layout.md + - cli/named-workspace-layout.md + - cli/workspace-custom-layout.md + - cli/named-workspace-custom-layout.md + - cli/workspace-layout-rule.md + - cli/named-workspace-layout-rule.md + - cli/workspace-custom-layout-rule.md + - cli/named-workspace-custom-layout-rule.md + - cli/clear-workspace-layout-rules.md + - cli/clear-named-workspace-layout-rules.md + - cli/workspace-tiling.md + - cli/named-workspace-tiling.md + - cli/workspace-name.md + - cli/toggle-window-container-behaviour.md + - cli/toggle-pause.md + - cli/toggle-tiling.md + - cli/toggle-float.md + - cli/toggle-monocle.md + - cli/toggle-maximize.md + - cli/restore-windows.md + - cli/manage.md + - cli/unmanage.md + - cli/reload-configuration.md + - cli/watch-configuration.md + - cli/complete-configuration.md + - cli/alt-focus-hack.md + - cli/window-hiding-behaviour.md + - cli/cross-monitor-move-behaviour.md + - cli/toggle-cross-monitor-move-behaviour.md + - cli/unmanaged-window-operation-behaviour.md + - cli/float-rule.md + - cli/manage-rule.md + - cli/initial-workspace-rule.md + - cli/initial-named-workspace-rule.md + - cli/workspace-rule.md + - cli/named-workspace-rule.md + - cli/identify-object-name-change-application.md + - cli/identify-tray-application.md + - cli/identify-layered-application.md + - cli/remove-title-bar.md + - cli/toggle-title-bars.md + - cli/identify-border-overflow-application.md + - cli/active-window-border.md + - cli/active-window-border-colour.md + - cli/active-window-border-width.md + - cli/active-window-border-offset.md + - cli/focus-follows-mouse.md + - cli/toggle-focus-follows-mouse.md + - cli/mouse-follows-focus.md + - cli/toggle-mouse-follows-focus.md + - cli/ahk-library.md + - cli/ahk-app-specific-configuration.md + - cli/pwsh-app-specific-configuration.md + - cli/format-app-specific-configuration.md + - cli/fetch-app-specific-configuration.md + - cli/application-specific-configuration-schema.md + - cli/notification-schema.md + - cli/socket-schema.md + - cli/static-config-schema.md + - cli/generate-static-config.md + - cli/enable-autostart.md + - cli/disable-autostart.md