1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-02 09:37:59 +01:00
psalm/docs/running_psalm.md
2019-02-12 17:47:02 -05:00

28 lines
858 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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
```
and Psalm will scan all files in the project referenced by `<projectFiles>`.
If you want to run on specific files, use
```bash
./vendor/bin/psalm file1.php [file2.php...]
```
## Command-line options
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:
- `--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.
Running them together (e.g. `--threads=8 --diff --diff-methods`) will result in the fastest possible Psalm run.