{"id":20543453,"url":"https://github.com/morgankryze/yabai-setup","last_synced_at":"2025-05-09T14:31:59.149Z","repository":{"id":222163828,"uuid":"756439048","full_name":"MorganKryze/Yabai-Setup","owner":"MorganKryze","description":"A simple set of functions to set up and use yabai.","archived":true,"fork":false,"pushed_at":"2024-02-14T21:20:09.000Z","size":241,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T04:42:51.054Z","etag":null,"topics":["config","macos","shell","yabai"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MorganKryze.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-12T17:04:05.000Z","updated_at":"2024-10-29T22:35:19.000Z","dependencies_parsed_at":"2024-02-12T18:43:57.876Z","dependency_job_id":null,"html_url":"https://github.com/MorganKryze/Yabai-Setup","commit_stats":null,"previous_names":["morgankryze/yabai-setup"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MorganKryze%2FYabai-Setup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MorganKryze%2FYabai-Setup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MorganKryze%2FYabai-Setup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MorganKryze%2FYabai-Setup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MorganKryze","download_url":"https://codeload.github.com/MorganKryze/Yabai-Setup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253266468,"owners_count":21880984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["config","macos","shell","yabai"],"created_at":"2024-11-16T01:37:55.647Z","updated_at":"2025-05-09T14:31:58.842Z","avatar_url":"https://github.com/MorganKryze.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yabai-Config\n\n\u003e A simple set of functions to set up and use yabai.\n\n![screenshot](./src/assets/img/screenshot.png)\n\n## Getting Started\n\n### Introduction\n\nThis project is a simple and clean configuration functions set for yabai. It is designed to be easy to use. The whole project uses [yabai](https://github.com/koekeishiya/yabai) and [skhd](https://github.com/koekeishiya/skhd) developped by [koekeishiya](https://github.com/koekeishiya).\n\n### Prerequisites\n\n- OS: macOS (version requirements are available in the readme of [yabai](https://github.com/koekeishiya/yabai))\n- zsh terminal\n\n### Install\n\nGet into your terminal in your home directory or where you want to install the project (somewhere stable).\n\nTo go to your home directory, use the following command:\n\n```sh\ncd ~\n```\n\nTo install the project, download the .zip file from github or use the following command:\n\n```sh\ngit clone https://github.com/MorganKryze/Yabai-Setup.git\n```\n\nThen, go to the project directory:\n\n```sh\ncd Yabai-Setup\n```\n\nYou can add the commands to your shell configuration file (e.g. `~/.zshrc`). To do so, use the following command:\n\n```sh\nzsh add-commands.sh\n```\n\n\u003e [!IMPORTANT]\n\u003e Before getting into the fun part, go to : System Settings \u003e Desktop \u0026 Dock \u003e Mission Control and **only check** \"Displays have separate Spaces\".\n\nThen, follow the steps described in this page to disable some System Integrity Protection (SIP) features: [yabai](https://github.com/koekeishiya/yabai/wiki/Disabling-System-Integrity-Protection).\n\n\u003e [!CAUTION]\n\u003e These steps above are not mandatory and can be dangerous but are recommended to use the full potential of yabai.\n\nNow, everything is set up. Start by running the following command:\n\n```sh\nyabai-help\n```\n\nNow you may start the installation process by running the following command:\n\n```sh\nyabai-install\n```\n\n\u003e [!NOTE]\n\u003e You will be asked to authorize yabai to access Accessibility features. You can do so by going to System Preferences \u003e Privacy \u0026 Security \u003e Accessibility and check the box next to yabai.\n\nThen, you can start yabai by running the following command:\n\n```sh\nyabai-start\n```\n\n### Usage\n\nNow that you have installed the project, you can use the following commands:\n\n- `yabai-help`: Display the help message.\n- `yabai-start`: Start yabai service.\n- `yabai-stop`: Stop yabai service.\n- `yabai-restart`: Restart yabai.\n- `yabai-uninstall`: Uninstall yabai (refer to [this page](https://github.com/koekeishiya/yabai/wiki/Disabling-System-Integrity-Protection) to re-enable system integrity protection)\n- `yabai-update`: Update the project alogside with yabai and skhd.\n  \n\u003e [!TIP]\n\u003e I recommend you to use the `yabai-update` often to stay up to date with the project.\n\n### Troubleshooting\n\nIf you encounter this error message (or for any command):\n\n```plaintext\nzsh: command not found: yabai-help\n```\n\nYou may not have add the path to the `yabai-setup.sh` file to your shell configuration file (e.g. `~/.zshrc`) or moved the project directory.\n\nThen redo the following command and restart your terminal (or add manually the path to your .zshrc located in `~/.zshrc`):\n\n```sh\nzsh add-commands.sh\n```\n\n### Project structure\n\nHere are the most important files and directories of the project( you may ignore the other files and directories):\n\n```plaintext\nYabai-Setup\n├── src\n│   ├── assets\n│   │   ├── img\n│   │   │   └── screenshot.png\n│   │   ├──.skhdrc.example\n│   │   └──.yabairc.example\n│   └── yabai-setup.sh\n├── .gitignore\n├── add-commands.sh\n├── SECURITY\n├── CODE_OF_CONDUCT\n├── CONTRIBUTING\n├── LICENCE\n└── README.md\n```\n\n#### Small descriptives\n\n##### `src/`\n\nThis directory contains the source code of the project.\n\n##### `src/assets/`\n\nThis directory contains the assets of the project.\n\n##### `.skhdrc.example` and `.yabairc.example`\n\nDefault configuration files for skhd and yabai (contains shortcuts and behaviors).\n\n##### `yabai-setup.sh`\n\nThe main file of the project. It contains the functions of the project.\n\n##### `add-commands.sh`\n\nA file to add the commands to your shell configuration file (e.g. `~/.zshrc`).\n\n## Supported platforms\n\n- MacOS (yabai is a MacOS only tiling manager)\n\n## Contributing\n\nIf you want to contribute to the project, you can follow the steps described in the [CONTRIBUTING](CONTRIBUTING) file.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorgankryze%2Fyabai-setup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmorgankryze%2Fyabai-setup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorgankryze%2Fyabai-setup/lists"}