yabai

by koekeishiya

koekeishiya / yabai

A tiling window manager for macOS based on binary space partitioning

4.9K Stars 222 Forks Last release: about 2 months ago (v3.3.0) MIT License 907 Commits 34 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Banner

Tiling window management for the Mac.

CI Status Badge License Badge Changelog Badge Version Badge

About

Screenshot

yabai is a window management utility that is designed to work as an extension to the built-in window manager of macOS. yabai allows you to control your windows, spaces and displays freely using an intuitive command line interface and optionally set user-defined keyboard shortcuts using ↗ skhd and other third-party software.

The primary function of yabai is tiling window management; automatically modifying your window layout using a binary space partitioning algorithm to allow you to focus on the content of your windows without distractions. Additional features of yabai include focus-follows-mouse, disabling animations for switching spaces, creating spaces past the limit of 16 spaces, and much more.

Installation and Configuration

  • The ↗ yabai wiki has both brief and detailed installation instructions for multiple installation methods, and also explains how to uninstall yabai completely.
  • Sample configuration files can be found in the ↗ examples directory. Refer to the ↗ documentation or the wiki for further information.
  • Keyboard shortcuts can be defined with ↗ skhd or any other suitable software you may prefer.

Requirements and Caveats

Please read the below requirements carefully. Make sure you fulfil all of them before filing an issue.

|Requirement|Note| |-:|:-| |Operating System|macOS High Sierra 10.13.6, Mojave 10.14.4+ and Catalina 10.15.0+ is supported.| |Accessibility API|yabai must be given permission to utilize the Accessibility API and will request access upon launch. The application must be restarted after access has been granted.| |Mission Control|In the Mission Control preferences pane in System Preferences, the setting "Displays have separate Spaces" must be enabled.|

Please also take note of the following caveats.

|Caveat|Note| |-:|:-| |System Integrity Protection|System Integrity Protection needs to be (partially) disabled for yabai to inject a scripting addition into Dock.app for controlling windows with functions that require elevated privileges. This enables control of the window server, which is the sole owner of all window connections, and enables additional features of yabai. If you are running on macOS High Sierra 10.13.6, you can reenable SIP after the scripting addition has been installed.| |Code Signing|When building from source (or installing from HEAD), it is recommended to codesign the binary so it retains its accessibility and automation privileges when updated or rebuilt.| |Mission Control|In the Mission Control preferences pane in System Preferences, the setting "Automatically rearrange Spaces based on most recent use" should be disabled for commands that rely on the ordering of spaces to work reliably.|

License and Attribution

yabai is licensed under the ↗ MIT License, a short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

Thanks to @fools-mate for creating a logo and banner for this project and making them available for free.

Thanks to @dominiklohmann for contributing great documentation, support, and more, for free.

Disclaimer

Use at your own discretion. I take no responsibility if anything should happen to your machine while trying to install, test or otherwise use this software in any form. You acknowledge that you understand the potential risk that may come from disabling ↗ System Integrity Protection on your system, and I make no recommendation as to whether you should or should not disable System Integrity Protection.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.