| 1 |
# Getting Started |
| 2 |
|
| 3 |
This section covers everything you need to install tarmac, grant it the required permissions, and start tiling your windows. |
| 4 |
|
| 5 |
## Overview |
| 6 |
|
| 7 |
tarmac runs as a background daemon on macOS. Once started, it: |
| 8 |
|
| 9 |
1. Discovers all open windows across all monitors |
| 10 |
2. Arranges them in a BSP (binary space partition) layout |
| 11 |
3. Listens for keyboard shortcuts to focus, swap, resize, and manage windows |
| 12 |
4. Accepts IPC commands over a Unix socket |
| 13 |
|
| 14 |
## Requirements |
| 15 |
|
| 16 |
- macOS 12 (Monterey) or later. Tested on Monterey, Ventura, Sonoma, and Tahoe. |
| 17 |
- Apple Silicon or Intel Mac |
| 18 |
- Accessibility permissions (required for window manipulation) |
| 19 |
- Rust toolchain if building from source |
| 20 |
|
| 21 |
## Quick install |
| 22 |
|
| 23 |
The fastest way to get started: |
| 24 |
|
| 25 |
```bash |
| 26 |
curl -fsSL https://tarmac.musicsian.com/install.sh | bash |
| 27 |
``` |
| 28 |
|
| 29 |
Or via Homebrew: |
| 30 |
|
| 31 |
```bash |
| 32 |
brew tap gardesk/tap |
| 33 |
brew install ers |
| 34 |
brew install tarmac |
| 35 |
``` |
| 36 |
|
| 37 |
See [Installation](/docs/getting-started/installation) for all installation methods. |
| 38 |
|
| 39 |
After installing, grant Accessibility permissions and run `tarmac`. See [First Run](/docs/getting-started/first-run) for details. |