Skip to content

Commit 3dc7970

Browse files
authoredFeb 26, 2025
✨ Add komorebi completions (#1055)
This is my first ever PR, hope I've done this right 😅
1 parent f9b9636 commit 3dc7970

File tree

2 files changed

+178
-0
lines changed

2 files changed

+178
-0
lines changed
 

‎custom-completions/komorebi/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# komorebi
2+
3+
[`komorebi`](https://github.com/LGUG2Z/komorebi) is a tiling window manager for Windows! It allows you to control application windows, virtual workspaces, and display monitors, with a CLI that works with third-party software like [`whkd`](https://github.com/LGUG2Z/whkd) and [AutoHotkey](https://github.com/AutoHotkey/AutoHotkey).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
def 'nu-complete komorebic commands' [] {
2+
[[value description];
3+
[quickstart 'Gather example configurations for a new-user quickstart']
4+
[start 'Start komorebi.exe as a background process']
5+
[stop 'Stop the komorebi.exe process and restore all hidden windows']
6+
[check 'Check komorebi configuration and related files for common errors']
7+
[configuration 'Show the path to komorebi.json']
8+
[bar-configuration 'Show the path to komorebi.bar.json']
9+
[whkdrc 'Show the path to whkdrc']
10+
[state 'Show a JSON representation of the current window manager state']
11+
[global-state 'Show a JSON representation of the current global state']
12+
[gui 'Launch the komorebi-gui debugging tool']
13+
[visible-windows 'Show a JSON representation of visible windows']
14+
[monitor-information 'Show information about connected monitors']
15+
[query 'Query the current window manager state']
16+
[subscribe-socket 'Subscribe to komorebi events using a Unix Domain Socket']
17+
[unsubscribe-socket 'Unsubscribe from komorebi events']
18+
[subscribe-pipe 'Subscribe to komorebi events using a Named Pipe']
19+
[unsubscribe-pipe 'Unsubscribe from komorebi events']
20+
[log "Tail komorebi.exe's process logs (cancel with Ctrl-C)"]
21+
[quick-save-resize 'Quicksave the current resize layout dimensions']
22+
[quick-load-resize 'Load the last quicksaved resize layout dimensions']
23+
[save-resize 'Save the current resize layout dimensions to a file']
24+
[load-resize 'Load the resize layout dimensions from a file']
25+
[focus 'Change focus to the window in the specified direction']
26+
[move 'Move the focused window in the specified direction']
27+
[minimize 'Minimize the focused window']
28+
[close 'Close the focused window']
29+
[force-focus 'Forcibly focus the window at the cursor with a left mouse click']
30+
[cycle-focus 'Change focus to the window in the specified cycle direction']
31+
[cycle-move 'Move the focused window in the specified cycle direction']
32+
[stack 'Stack the focused window in the specified direction']
33+
[unstack 'Unstack the focused window']
34+
[cycle-stack 'Cycle the focused stack in the specified cycle direction']
35+
[focus-stack-window 'Focus the specified window index in the focused stack']
36+
[stack-all 'Stack all windows on the focused workspace']
37+
[unstack-all 'Unstack all windows in the focused container']
38+
[resize-edge 'Resize the focused window in the specified direction']
39+
[resize-axis 'Resize the focused window or primary column along the specified axis']
40+
[move-to-monitor 'Move the focused window to the specified monitor']
41+
[cycle-move-to-monitor 'Move the focused window to the monitor in the given cycle direction']
42+
[move-to-workspace 'Move the focused window to the specified workspace']
43+
[move-to-named-workspace 'Move the focused window to the specified workspace']
44+
[cycle-move-to-workspace 'Move the focused window to the workspace in the given cycle direction']
45+
[send-to-monitor 'Send the focused window to the specified monitor']
46+
[cycle-send-to-monitor 'Send the focused window to the monitor in the given cycle direction']
47+
[send-to-workspace 'Send the focused window to the specified workspace']
48+
[send-to-named-workspace 'Send the focused window to the specified workspace']
49+
[cycle-send-to-workspace 'Send the focused window to the workspace in the given cycle direction']
50+
[send-to-monitor-workspace 'Send the focused window to the specified monitor workspace']
51+
[move-to-monitor-workspace 'Move the focused window to the specified monitor workspace']
52+
[focus-monitor 'Focus the specified monitor']
53+
[focus-last-workspace 'Focus the last focused workspace on the focused monitor']
54+
[focus-workspace 'Focus the specified workspace on the focused monitor']
55+
[focus-workspaces 'Focus the specified workspace on all monitors']
56+
[focus-monitor-workspace 'Focus the specified workspace on the target monitor']
57+
[focus-named-workspace 'Focus the specified workspace']
58+
[cycle-monitor 'Focus the monitor in the given cycle direction']
59+
[cycle-workspace 'Focus the workspace in the given cycle direction']
60+
[move-workspace-to-monitor 'Move the focused workspace to the specified monitor']
61+
[cycle-move-workspace-to-monitor 'Move the focused workspace monitor in the given cycle direction']
62+
[swap-workspaces-with-monitor 'Swap focused monitor workspaces with specified monitor']
63+
[new-workspace 'Create and append a new workspace on the focused monitor']
64+
[resize-delta 'Set the resize delta (used by resize-edge and resize-axis)']
65+
[invisible-borders 'Set the invisible border dimensions around each window']
66+
[global-work-area-offset 'Set offsets to exclude parts of the work area from tiling']
67+
[monitor-work-area-offset 'Set offsets for a monitor to exclude parts of the work area from tiling']
68+
[focused-workspace-container-padding 'Set container padding on the focused workspace']
69+
[focused-workspace-padding 'Set workspace padding on the focused workspace']
70+
[adjust-container-padding 'Adjust container padding on the focused workspace']
71+
[adjust-workspace-padding 'Adjust workspace padding on the focused workspace']
72+
[change-layout 'Set the layout on the focused workspace']
73+
[cycle-layout 'Cycle between available layouts']
74+
[flip-layout 'Flip the layout on the focused workspace (BSP only)']
75+
[promote 'Promote the focused window to the top of the tree']
76+
[promote-focus 'Promote the user focus to the top of the tree']
77+
[promote-window 'Promote the window in the specified direction']
78+
[retile 'Force the retiling of all managed windows']
79+
[monitor-index-preference 'Set the monitor index preference for a monitor identified using its size']
80+
[display-index-preference 'Set the display index preference for a monitor identified using its display name']
81+
[ensure-workspaces 'Create at least this many workspaces for the specified monitor']
82+
[ensure-named-workspaces 'Create these many named workspaces for the specified monitor']
83+
[container-padding 'Set the container padding for the specified workspace']
84+
[named-workspace-container-padding 'Set the container padding for the specified workspace']
85+
[workspace-padding 'Set the workspace padding for the specified workspace']
86+
[named-workspace-padding 'Set the workspace padding for the specified workspace']
87+
[workspace-layout 'Set the layout for the specified workspace']
88+
[named-workspace-layout 'Set the layout for the specified workspace']
89+
[workspace-layout-rule 'Add a dynamic layout rule for the specified workspace']
90+
[named-workspace-layout-rule 'Add a dynamic layout rule for the specified workspace']
91+
[clear-workspace-layout-rules 'Clear all dynamic layout rules for the specified workspace']
92+
[clear-named-workspace-layout-rules 'Clear all dynamic layout rules for the specified workspace']
93+
[workspace-tiling 'Enable or disable window tiling for the specified workspace']
94+
[named-workspace-tiling 'Enable or disable window tiling for the specified workspace']
95+
[workspace-name 'Set the workspace name for the specified workspace']
96+
[toggle-window-container-behaviour 'Toggle the behaviour for new windows (stacking or dynamic tiling)']
97+
[toggle-float-override 'Enable or disable float override, which makes it so every new window opens in floating mode']
98+
[toggle-workspace-window-container-behavior 'Toggle the behaviour for new windows (stacking or dynamic tiling) for currently focused workspace. If there was no behaviour set for the workspace previously it takes the opposite of the global value']
99+
[toggle-workspace-float-override 'Enable or disable float override, which makes it so every new window opens in floating mode, for the currently focused workspace. If there was no override value set for the workspace previously it takes the opposite of the global value']
100+
[toggle-pause 'Toggle window tiling on the focused workspace']
101+
[toggle-tiling 'Toggle window tiling on the focused workspace']
102+
[toggle-float 'Toggle floating mode for the focused window']
103+
[toggle-monocle 'Toggle monocle mode for the focused container']
104+
[toggle-maximize 'Toggle native maximization for the focused window']
105+
[restore-windows 'Restore all hidden windows (debugging command)']
106+
[manage 'Force komorebi to manage the focused window']
107+
[unmanage 'Unmanage a window that was forcibly managed']
108+
[replace-configuration 'Replace the configuration of a running instance of komorebi from a static configuration file']
109+
[reload-configuration 'Reload legacy komorebi.ahk or komorebi.ps1 configurations (if they exist)']
110+
[watch-configuration 'Enable or disable watching of legacy komorebi.ahk or komorebi.ps1 configurations (if they exist)']
111+
[complete-configuration 'For legacy komorebi.ahk or komorebi.ps1 configurations, signal that the final configuration option has been sent']
112+
[window-hiding-behaviour 'Set the window behaviour when switching workspaces / cycling stacks']
113+
[cross-monitor-move-behaviour 'Set the behaviour when moving windows across monitor boundaries']
114+
[toggle-cross-monitor-move-behaviour 'Toggle the behaviour when moving windows across monitor boundaries']
115+
[unmanaged-window-operation-behaviour 'Set the operation behaviour when the focused window is not managed']
116+
[ignore-rule 'Add a rule to ignore the specified application']
117+
[manage-rule 'Add a rule to always manage the specified application']
118+
[initial-workspace-rule 'Add a rule to associate an application with a workspace on first show']
119+
[initial-named-workspace-rule 'Add a rule to associate an application with a named workspace on first show']
120+
[workspace-rule 'Add a rule to associate an application with a workspace']
121+
[named-workspace-rule 'Add a rule to associate an application with a named workspace']
122+
[clear-workspace-rules 'Remove all application association rules for a workspace by monitor and workspace index']
123+
[clear-named-workspace-rules 'Remove all application association rules for a named workspace']
124+
[clear-all-workspace-rules 'Remove all application association rules for all workspaces']
125+
[identify-object-name-change-application 'Identify an application that sends EVENT_OBJECT_NAMECHANGE on launch']
126+
[identify-tray-application 'Identify an application that closes to the system tray']
127+
[identify-layered-application 'Identify an application that has WS_EX_LAYERED, but should still be managed']
128+
[remove-title-bar 'Whitelist an application for title bar removal']
129+
[toggle-title-bars 'Toggle title bars for whitelisted applications']
130+
[border 'Enable or disable borders']
131+
[border-colour 'Set the colour for a window border kind']
132+
[border-width 'Set the border width']
133+
[border-offset 'Set the border offset']
134+
[border-style 'Set the border style']
135+
[border-implementation 'Set the border implementation']
136+
[transparency 'Enable or disable transparency for unfocused windows']
137+
[transparency-alpha 'Set the alpha value for unfocused window transparency']
138+
[toggle-transparency 'Toggle transparency for unfocused windows']
139+
[animation 'Enable or disable movement animations']
140+
[animation-duration 'Set the duration for movement animations in ms']
141+
[animation-fps 'Set the frames per second for movement animations']
142+
[animation-style 'Set the ease function for movement animations']
143+
[mouse-follows-focus 'Enable or disable mouse follows focus on all workspaces']
144+
[toggle-mouse-follows-focus 'Toggle mouse follows focus on all workspaces']
145+
[ahk-app-specific-configuration 'Generate common app-specific configurations and fixes to use in komorebi.ahk']
146+
[pwsh-app-specific-configuration 'Generate common app-specific configurations and fixes in a PowerShell script']
147+
[convert-app-specific-configuration 'Convert a v1 ASC YAML file to a v2 ASC JSON file']
148+
[fetch-app-specific-configuration 'Fetch the latest version of applications.json from komorebi-application-specific-configuration']
149+
[application-specific-configuration-schema 'Generate a JSON Schema for applications.json']
150+
[notification-schema 'Generate a JSON Schema of subscription notifications']
151+
[socket-schema 'Generate a JSON Schema of socket messages']
152+
[static-config-schema 'Generate a JSON Schema of the static configuration file']
153+
[generate-static-config 'Generates a static configuration JSON file based on the current window manager state']
154+
[enable-autostart 'Generates the komorebi.lnk shortcut in tartup to autostart komorebi']
155+
[disable-autostart 'Deletes the komorebi.lnk shortcut in tartup to disable autostart']
156+
[help 'Print this message or the help of the given subcommand(s)']
157+
]
158+
}
159+
160+
export extern komorebi [
161+
# A tiling window manager for Windows
162+
--ffm (-f) # Allow the use of komorebi's custom focus-follows-mouse implementation
163+
--await-configuration (-a) # Wait for 'komorebic complete-configuration' to be sent before processing events
164+
--tcp-port: int (-t) # Start a TCP server on the given port to allow the direct sending of SocketMessages
165+
--config: string (-c) # Path to a static configuration JSON file
166+
--help (-h) # Print help
167+
--version (-V) # Print version
168+
]
169+
170+
export extern komorebic [
171+
# The command-line interface for Komorebi, a tiling window manager for Windows
172+
string?: string@'nu-complete komorebic commands'
173+
--bar # Start komorebi with bar
174+
--whkd # Start komorebic with whkd
175+
]

0 commit comments

Comments
 (0)