Skip to content

mrmurphy/phoenix

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

99 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Phoenix

Build Status

A lightweight OS X window manager for JavaScript. Phoenix aims for efficiency and a very small footprint. If you like the idea of scripting your own window management toolkit with JavaScript, Phoenix is probably going to give you the things you want.

  • Current version: 1.2
  • Requires: OS X 10.9 or higher

Note: the default master-branch will always be stable.

Install

To install Phoenix, you will first need to build it. Install Xcode from the App Store, if you do not already have it installed. You will also need Xcode command line tools — you will be prompted for this. Then, from a terminal run the following:

git clone https://github.com/kasper/phoenix.git
cd phoenix
xcodebuild clean build

Once complete, you will find a newly built Phoenix app in build/Release/. To install, just drag-and-drop it to your Applications-folder. When you run Phoenix for the first time, you will be asked to allow it to control your UI. OS X will ask you to open Security & Privacy in System Preferences. Once open, go to the Accessibility-section and click the checkbox next to Phoenix to enable control. An admin account is required to accomplish this.

Usage

Phoenix can only be scripted in JavaScript (or languages which compile to JavaScript such as CoffeeScript). See the JavaScript API to get started with your script. Your script should reside in ~/.phoenix.js — the file will be created when you launch Phoenix for the first time. For ideas, see what other people have built in their configurations in the Wiki. Feel free to add your own configuration to the Wiki to show other people the nice things you can do.

Contributing

Feel free to contribute to this project by creating issues, pull requests and editing the Wiki. See the guidelines.

Thanks

Phoenix is currently developed by Kasper Hirvikoski (@kasper) and Jason Milkins (@jasonm23) with the generous help of contributions made by many individuals. It was originally authored by Steven Degutis (@sdegutis) as a fork of Zephyros — also an app of his. Steven is continuing his work on OS X window management in Mjolnir.

License

Released under the MIT License. See license.

About

A lightweight OS X window manager for JavaScript

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Objective-C 100.0%