1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-30 04:39:00 +01:00
psalm/docs/running_psalm.md

28 lines
858 B
Markdown
Raw Normal View History

2018-02-18 01:53:17 +01:00
# Running Psalm
Once you've set up your config file, you can run Psalm from your project's root directory with
```bash
./vendor/bin/psalm
```
2019-02-12 23:35:28 +01:00
and Psalm will scan all files in the project referenced by `<projectFiles>`.
2018-02-18 01:53:17 +01:00
If you want to run on specific files, use
```bash
./vendor/bin/psalm file1.php [file2.php...]
```
## Command-line options
2018-02-18 01:53:17 +01:00
Run with `--help` to see a list of options that Psalm supports.
### Running Psalm faster
Psalm has a couple of command-line options that will result in faster builds:
2018-09-30 22:05:42 +02:00
- `--threads=[n]` to run Psalms analysis in a number of threads
- `--diff` which only checks files youve updated (and their dependents).
- `--diff-methods` which remembers Psalms output when scanning particular methods.
2018-09-30 22:05:42 +02:00
Running them together (e.g. `--threads=8 --diff --diff-methods`) will result in the fastest possible Psalm run.