# Slither, the Solidity source analyzer
[](https://travis-ci.com/trailofbits/slither)
Slither is a Solidity static analysis framework written in Python 3. It provides an API to easily manipulate Solidity code. In addition to exposing a Solidity contracts AST, Slither provides many APIs to quickly check local and state variable usage.
With Slither you can:
- Detect vulnerabilities
- Speed up your understanding of code
- Build custom analyses to answer specific questions
- Quickly prototype a new static analysis techniques
## How to install
Slither uses Python 3.6.
```bash
$ python setup.py install
```
You may also want solc, the Solidity compiler, which can be installed using homebrew:
```bash
$ brew update
$ brew upgrade
$ brew tap ethereum/ethereum
$ brew install solidity
$ brew linkapps solidity
```
or with aptitude:
```bash
$ sudo add-apt-repository ppa:ethereum/ethereum
$ sudo apt-get update
$ sudo apt-get install solc
```
## How to use
```
$ slither file.sol
```
```
$ slither examples/uninitialized.sol
[..]
INFO:Detectors:Uninitialized state variables in examples/uninitialized.sol, Contract: Uninitialized, Vars: destination, Used in ['transfer']
[..]
```
If Slither is applied on a directory, it will run on every `.sol` file of the directory.
## Options
### Configuration
* `--solc SOLC` : Path to `solc` (default 'solc')
* `--disable-solc-warnings` : Do not print solc warnings
* `--solc-ast` : Use the solc AST file as input (`solc file.sol --ast-json > file.ast.json`)
* `--json FILE` : Export results as JSON
* `--solc-args SOLC_ARGS` : Add custom solc arguments. `SOLC_ARGS` can contain multiple arguments.
### Analyses
* `--high` : Run only medium/high severity checks with high confidence
* `--medium` : Run only medium/high severity checks with medium confidence
* `--low` : Run only low severity checks
### Printers
* `--print-summary` : Print a summary of the contracts
* `--print-quick-summary` : Print a quick summary of the contracts
* `--print-inheritance` : Print the inheritance graph
For more information about printers, see the [Printers documentation ](docs/PRINTERS.md )
## Checks available
Check | Purpose | Impact | Confidence
--- | --- | --- | ---
`--uninitialized` | Detect uninitialized variables | High | High
`--pragma` | Detect if different pragma directives are used | Informational | High
`--solc-version` | Detect if an old version of Solidity is used (< 0.4.23 ) | Informational | High
## License
Slither is licensed and distributed under AGPLv3. [Contact us ](mailto:opensource@trailofbits.com ) if you're looking for an exception to the terms.
