| 1 | # [PhantomJS](http://phantomjs.org) - Scriptable Headless WebKit
|
|---|
| 2 |
|
|---|
| 3 | PhantomJS ([www.phantomjs.org](http://phantomjs.org)) is a headless WebKit scriptable with JavaScript or CoffeeScript. It is used by hundreds of [developers](https://github.com/ariya/phantomjs/wiki/Buzz) and dozens of [organizations](https://github.com/ariya/phantomjs/wiki/Users) for web-related development workflow.
|
|---|
| 4 |
|
|---|
| 5 | The latest [stable release](http://phantomjs.org/release-1.9.html) is version 1.9 (codenamed <a href="http://phantomjs.org/release-names.html">"Sakura"</a>). Follow the official Twitter stream [@PhantomJS](http://twitter.com/PhantomJS) to get the frequent development updates.
|
|---|
| 6 |
|
|---|
| 7 | **Note**: Please **do not** create a GitHub pull request **without** reading the [Contribution Guide](https://github.com/ariya/phantomjs/blob/master/CONTRIBUTING.md) first. Failure to do so may result in the rejection of the pull request.
|
|---|
| 8 |
|
|---|
| 9 | ## Use Cases
|
|---|
| 10 |
|
|---|
| 11 | - **Headless web testing**. Lightning-fast testing without the browser is now possible! Various [test frameworks](https://github.com/ariya/phantomjs/wiki/Headless-Testing) such as Jasmine, Capybara, QUnit, Mocha, WebDriver, YUI Test, BusterJS, FuncUnit, Robot Framework, and many others are supported.
|
|---|
| 12 | - **Page automation**. [Access and manipulate](https://github.com/ariya/phantomjs/wiki/Page-Automation) web pages with the standard DOM API, or with usual libraries like jQuery.
|
|---|
| 13 | - **Screen capture**. Programmatically [capture web contents](https://github.com/ariya/phantomjs/wiki/Screen-Capture), including CSs, SVG and Canvas. Build server-side web graphics apps, from a screenshot service to a vector chart rasterizer.
|
|---|
| 14 | - **Network monitoring**. Automate performance analysis, track [page loading](https://github.com/ariya/phantomjs/wiki/Network-Monitoring) and export as standard HAR format.
|
|---|
| 15 |
|
|---|
| 16 | ## Features
|
|---|
| 17 |
|
|---|
| 18 | - **Multiplatform**, available on major operating systems: Windows, Mac OS X, Linux, other Unices.
|
|---|
| 19 | - **Fast and native implementation** of web standards: DOM, CSS, JavaScript, Canvas, SVG. No emulation!
|
|---|
| 20 | - **Pure headless (no X11) on Linux**, ideal for continuous integration systems. Also runs on Amazon EC2, Heroku, Iron.io.
|
|---|
| 21 | - **Easy to install**: [Download](http://phantomjs.org/download.html), unpack, and start having fun in just 5 minutes.
|
|---|
| 22 |
|
|---|
| 23 | ## Ecosystem
|
|---|
| 24 |
|
|---|
| 25 | PhantomJS needs not be used only as a stand-alone tool. Check also some excellent related projects:
|
|---|
| 26 |
|
|---|
| 27 | - [CasperJS](http://casperjs.org) enables easy navigation scripting and common high-level testing.
|
|---|
| 28 | - [Poltergeist](https://github.com/jonleighton/poltergeist) allows running Capybara tests headlessly.
|
|---|
| 29 | - [Guard::Jasmine](https://github.com/netzpirat/guard-jasmine) automatically tests Jasmine specs on Rails when files are modified.
|
|---|
| 30 | - [GhostDriver](http://github.com/detro/ghostdriver/) complements Selenium tests with a PhantomJS WebDriver implementation.
|
|---|
| 31 | - [PhantomRobot](https://github.com/datakurre/phantomrobot) runs Robot Framework acceptance tests in the background via PhantomJS.
|
|---|
| 32 | - [Mocha-PhantomJS](https://github.com/metaskills/mocha-phantomjs) run Mocha tests using PhantomJS.
|
|---|
| 33 |
|
|---|
| 34 | and many others [related projects](https://github.com/ariya/phantomjs/wiki/Related-Projects).
|
|---|
| 35 |
|
|---|
| 36 | ## Questions?
|
|---|
| 37 |
|
|---|
| 38 | - Explore the complete [documentation](https://github.com/ariya/phantomjs/wiki)
|
|---|
| 39 | - Read tons of [user articles](https://github.com/ariya/phantomjs/wiki/Buzz) on using PhantomJS.
|
|---|
| 40 | - Join the [mailing-list](http://groups.google.com/group/phantomjs) and discuss with other PhantomJS fans.
|
|---|
| 41 |
|
|---|
| 42 | PhantomJS is free software/open source, and is distributed under the [BSD license](http://opensource.org/licenses/BSD-3-Clause). It contains third-party code, see the included `third-party.txt` file for the license information on third-party code.
|
|---|
| 43 |
|
|---|
| 44 | PhantomJS is created and maintained by [Ariya Hidayat](http://ariya.ofilabs.com/about) (Twitter: [@ariyahidayat](http://twitter.com/ariyahidayat)), with the help of [many contributors](https://github.com/ariya/phantomjs/contributors).
|
|---|
| 45 |
|
|---|
