1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-02 09:37:59 +01:00
psalm/docs/installation.md
2019-05-29 23:50:24 -04:00

30 lines
652 B
Markdown

# Installation
Psalm Requires PHP >= 7.1 and [Composer](https://getcomposer.org/).
```bash
composer require --dev vimeo/psalm
```
Add a `psalm.xml` config:
```bash
./vendor/bin/psalm --init [source_directory=src] [config_level=3]
```
where `config_level` represents how strict you want Psalm to be. `1` is the strictest, `8` is the most lenient.
Example:
```console
$ ./vendor/bin/psalm --init src 3
Config file created successfully. Please re-run psalm.
```
Then run Psalm:
```bash
./vendor/bin/psalm
```
Psalm will probably find a number of issues - find out how to deal with them in [Dealing with code issues](dealing_with_code_issues.md).