1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-04 02:27:59 +01:00
psalm/docs/running_psalm/installation.md

30 lines
652 B
Markdown
Raw Normal View History

2018-02-18 01:53:17 +01:00
# Installation
2019-05-30 05:50:24 +02:00
Psalm Requires PHP >= 7.1 and [Composer](https://getcomposer.org/).
2018-02-18 01:53:17 +01:00
```bash
2018-04-15 16:56:43 +02:00
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.
2018-04-15 18:17:07 +02:00
Example:
```console
$ ./vendor/bin/psalm --init src 3
Config file created successfully. Please re-run psalm.
```
2018-04-15 16:56:43 +02:00
Then run Psalm:
```bash
./vendor/bin/psalm
2018-02-18 01:53:17 +01:00
```
2019-03-19 17:08:22 +01:00
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).