README.md
1# MacOS plugin
2
3This plugin provides a few utilities to make it more enjoyable on macOS (previously named OSX).
4
5To start using it, add the `macos` plugin to your plugins array in `~/.zshrc`:
6
7```zsh
8plugins=(... macos)
9```
10
11Original author: [Sorin Ionescu](https://github.com/sorin-ionescu)
12
13## Commands
14
15| Command | Description |
16| :------------ | :------------------------------------------------------- |
17| `tab` | Open the current directory in a new tab |
18| `split_tab` | Split the current terminal tab horizontally |
19| `vsplit_tab` | Split the current terminal tab vertically |
20| `ofd` | Open the current directory in a Finder window |
21| `pfd` | Return the path of the frontmost Finder window |
22| `pfs` | Return the current Finder selection |
23| `cdf` | `cd` to the current Finder directory |
24| `pushdf` | `pushd` to the current Finder directory |
25| `pxd` | Return the current Xcode project directory |
26| `cdx` | `cd` to the current Xcode project directory |
27| `quick-look` | Quick-Look a specified file |
28| `man-preview` | Open a specified man page in Preview app |
29| `showfiles` | Show hidden files in Finder |
30| `hidefiles` | Hide the hidden files in Finder |
31| `itunes` | _DEPRECATED_. Use `music` from macOS Catalina on |
32| `music` | Control Apple Music. Use `music -h` for usage details |
33| `spotify` | Control Spotify and search by artist, album, track… |
34| `rmdsstore` | Remove .DS_Store files recursively in a directory |
35| `btrestart` | Restart the Bluetooth daemon |
36| `freespace` | Erases purgeable disk space with 0s on the selected disk |
37
38## Acknowledgements
39
40This application makes use of the following third party scripts:
41
42[shpotify](https://github.com/hnarayanan/shpotify)
43
44Copyright (c) 2012–2019 [Harish Narayanan](https://harishnarayanan.org/).
45
46Permission is hereby granted, free of charge, to any person obtaining
47a copy of this software and associated documentation files (the
48"Software"), to deal in the Software without restriction, including
49without limitation the rights to use, copy, modify, merge, publish,
50distribute, sublicense, and/or sell copies of the Software, and to
51permit persons to whom the Software is furnished to do so, subject to
52the following conditions:
53
54The above copyright notice and this permission notice shall be
55included in all copies or substantial portions of the Software.
56
57THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
58EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
59MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
60NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
61LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
62OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
63WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
64