CLI Options
Below are options which may be included with the aderyn CLI command.
aderyn <ROOT>
aderyn <ROOT>
- Detects if the current directory is a Foundry project and runs the Aderyn static analyser over it.
Input:
aderyn .
--help
--help
Outputs the options and arguments available when using Aderyn.
-o, --output <OUTPUT>
-o, --output <OUTPUT>
- The default output is report.md
. This can be renamed to anything you'd like. Currently supported formats include Markdown and JSON. JSON is particularly useful in CI/CD pipelines to compile properties from the generated report.
Examples:
-s, --scope <SCOPE>
-s, --scope <SCOPE>
A string, or list of strings separated by commas that pertain to the filenames/directories in scope. These are the files/directories that Aderyn will be run on.
Note: strings passed to the scope command are case-sensitive.
Examples will be based on the blow repo:
Input:
aderyn -s src/interfaces
Output:
Input:
aderyn --scope Thund
Output:
-e, --exclude <EXCLUDE>
-e, --exclude <EXCLUDE>
the opposite of --scope
, this will exclude any files or directories that contain the passed string.
Input:
aderyn -e Thunder
Output:
-n, --no-snippets
-n, --no-snippets
The default behavior is to include the line number, as well as snippets of code where the vulnerability is detected within the generated report. This can potentially take up a lot of space in the report. This option will disable the snippets, leaving the line number readouts only.
Input (default):
aderyn -s Thunder`
Found in src/protocol/ThunderLoan.sol Line: 239
Input (no-snippets):
Output:
Found in src/protocol/ThunderLoan.sol Line: 239
aderyn --version
aderyn --version
Outputs the current version of Aderyn installed
Input:
Output:
aderyn 0.0.13
aderyn registry
aderyn registry
Output the list of detectors.
Input:
Output:
Last updated