Skip to content

Commit

Permalink
only slither report
Browse files Browse the repository at this point in the history
  • Loading branch information
Aniket-Engg committed Jul 27, 2021
1 parent e588864 commit a8965c1
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
Binary file added docs/images/a-slither-analysis-only.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 19 additions & 1 deletion docs/slither.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,25 @@ It doesn't need any separate installation as it is shipped with [remixd NPM](htt
Enable Slither Analysis
------------------

### Prerequisites

To use Slither analysis with Remix IDE efficiently, following tools should be installed locally on the system:

1. **Slither:** [https://github.com/crytic/slither#how-to-install](https://github.com/crytic/slither#how-to-install)
2. **Solc:** [https://docs.soliditylang.org/en/latest/installing-solidity.html](https://docs.soliditylang.org/en/latest/installing-solidity.html)
3. **Solc-select:** [https://github.com/crytic/solc-select#quickstart](https://github.com/crytic/solc-select#quickstart)

### How to use

If a project is shared through remixd and `localhost` workspace is loaded in Remix IDE, there will be an extra checkbox shown in `Solidity Static Analysis` plugin with the label `Enable Slither Analysis`.

![](images/a-slither-analysis.png)

One can check this box to run the analysis using Slither along with the Remix.

Generated report of Slither analysis will be stored locally on project root with a file name prefixed with `remix-slitherReport_`, for example: `remix-slitherReport_1627362090.json`. This report will also be displayed on the Remix IDE side after the Remix analysis report for better user readability.
Generated report of Slither analysis will be stored locally on project root with a file name prefixed with `remix-slitherReport_`, for example: `remix-slitherReport_1627362090.json`.

Slither Analysis report will also be displayed on the Remix IDE side after the Remix analysis report for better user readability.

![](images/a-slither-analysis-success.png)

Expand All @@ -39,6 +51,12 @@ and also in the **remixd** console.

![](images/a-slither-analysis-success-remixd.png)

If one want to run the analysis only for Slither, deselect `Select all` checkbox and click on `Run`. Now it will show only the Slither Analysis report.

![](images/a-slither-analysis-only.png)






0 comments on commit a8965c1

Please sign in to comment.