2016-12-07 06:24:29 +01:00
< img src = "https://travis-ci.org/vimeo/psalm.svg?branch=master" / >
2016-12-12 21:32:01 +01:00
< h1 > < a href = "https://getpsalm.org" > < img src = "PsalmLogo.png" height = "64" alt = "logo" / > < / a > < / h1 >
2016-07-18 22:46:44 +02:00
2016-12-05 05:19:14 +01:00
Psalm is a static analysis tool for finding errors in PHP applications.
2016-12-12 16:29:43 +01:00
- **v0.3.x** supports checking PHP 5.4 - 7.1 code, and requires **PHP 5.5+** to run.
- **v0.2.x** supports checking PHP 5.4 - 7.0 code and requires **PHP 5.4+** to run.
2016-11-11 20:19:31 +01:00
2016-12-12 18:02:31 +01:00
Check out the [wiki ](https://github.com/vimeo/psalm/wiki ) or [try a live demo ](https://getpsalm.org/ )!
2016-11-21 21:15:23 +01:00
## Quickstart Guide
Install via [Composer ](https://getcomposer.org/ ):
```bash
composer require --dev "vimeo/psalm:dev-master"
composer install
```
Add a `psalm.xml` config:
```bash
cat > psalm.xml < < EOF
<?xml version="1.0"?>
< psalm
stopOnFirstError="false"
useDocblockTypes="true"
>
< inspectFiles >
< directory name = "src" / >
< / inspectFiles >
< / psalm >
EOF
```
Then run Psalm with:
```bash
./vendor/bin/psalm
```
The above config is spartan, and will show you *all* possible errors, including many that are likely irrelevant to you. A more lenient config is provided [here ](examples/psalm.default.xml ).
