\n\n## What is Aderyn?\n\n**Aderyn is an open-source public good developer tool.** It is a Rust-based solidity smart contract static analyzer designed to help protocol engineers and security researchers find vulnerabilities in Solidity code bases.\n\nYou can read the [Cyfrin official documentation](https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/readme) for an in-depth look at Aderyn's functionalities.\n\nThere is also an officially supported [VSCode extension](https://github.com/Cyfrin/vscode-aderyn/) for Aderyn. Download from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Cyfrin.aderyn&ssr=false#overview) and start identifying vulnerabilities in your Solidity \ncode with ease. \n\n## Features\n\n- Runs without need for any configuration support for Foundry and Hardhat projects.\n- Creates Markdown, JSON and Sarif reports.\n- Powers our officially supported [VSCode extension](https://github.com/Cyfrin/vscode-aderyn/) (1800+ downloads)\n- List of [supported detectors](https://cyfrin.gitbook.io/cyfrin-docs/project-configuration/list-of-supported-detectors)\n- Contributor Friendly\n- Downloaded more than 45K times. \n\n## Installation\n\n> **NOTE** Windows users must have WSL installed\n\n#### Cyfrinup - All in one cross platform installation manager for Cyfrin tools.\n\n[One time setup](https://github.com/Cyfrin/up). - Run `cyfrinup`\n\nRe-run `cyfrinup` to upgrade all Cyfrin tools to the latest version.\n\n#### Curl\nOnce installed, run `aderyn-update` to upgrade.\n```sh\ncurl --proto '=https' --tlsv1.2 -LsSf https://github.com/cyfrin/aderyn/releases/latest/download/aderyn-installer.sh | bash\n```\n\n\n#### Homebrew\nOnce installed, run `brew upgrade cyfrin/tap/aderyn` to upgrade.\n```sh\nbrew install cyfrin/tap/aderyn\n```\n\n#### npm\nOnce installed, re-run `npm install @cyfrin/aderyn -g` to upgrade.\n```sh\nnpm install @cyfrin/aderyn -g\n```\n\nIf you are installing with Curl or Homebrew or npm, ensure that the correct version of Aderyn in your path comes from either the Homebrew or npm global packages directory. If an older version exists at `~/.cyfrin/bin/aderyn`, remove it using `rm -f ~/.cyfrin/bin/aderyn`, as this is no longer the default installation location.\n\n## Quick Start\n\nRun `aderyn --version` to check if Aderyn is installed successfully.\n\n[Quick Start](https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/quickstart) example with video guide.\n\n```\ncd path/to/solidity/project/root\naderyn\n```\n\nThis generates a [report.md](https://github.com/Cyfrin/aderyn/blob/dev/reports/report.md)\n\nSee examples using more CLI options [here](https://cyfrin.gitbook.io/cyfrin-docs/cli-options)\n\n## VS Code extension\n\nOfficially supported [VSCode extension](https://github.com/Cyfrin/vscode-aderyn/) for Aderyn. \nDownload from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Cyfrin.aderyn&ssr=false#overview)\n\n## Github Action\n\nCheckout [Aderyn CI Assistant](https://github.com/marketplace/actions/aderyn-ci-assistant) in the marketplace.\nPerforms Static analysis on Solidity codebases in CI to catch potential vulnerabilities before committing code. \n\n## Contributing & License\n\nHelp us build Aderyn 🦜 Please see our [contribution guidelines](./CONTRIBUTING.md) for in-depth developer environment setup and PR approval process.\nAderyn is an open-source software licensed under the [GPL-3.0 License](./LICENSE).\n\nTo learn how to create your custom Aderyn detectors, [checkout the official docs](https://cyfrin.gitbook.io/cyfrin-docs/aderyn-cli/detectors-quickstart)\n\nAderyn relies on a [custom backend](https://github.com/Cyfrin/solidity-ast-rs) to generate AST for Solidity codebases. \nIt leverages [foundry-compilers](https://github.com/foundry-rs/compilers) \n\n## Credits\n\nThis project exists thanks to all the people who [contribute](/CONTRIBUTING.md). \n\n\n \n\n\n## Attribution\n\n- Initial inspiration for AST Visitor code from [solc-ast-rs](https://github.com/hrkrshnn/solc-ast-rs).\n- Original detectors based on [4naly3er](https://github.com/Picodes/4naly3er) detectors.\n- Shoutout to the original king of static analysis [slither](https://github.com/crytic/slither).\n\n\n[contributors-shield]: https://img.shields.io/github/contributors/cyfrin/aderyn\n[contributors-url]: https://github.com/cyfrin/aderyn/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/cyfrin/aderyn\n[forks-url]: https://github.com/cyfrin/aderyn/network/members\n[stars-shield]: https://img.shields.io/github/stars/cyfrin/aderyn\n[stars-url]: https://github.com/cyfrin/aderyn/stargazers\n[release-shield]: https://img.shields.io/github/v/release/Cyfrin/aderyn\n[release-url]: https://github.com/Cyfrin/aderyn/releases\n[issues-shield]: https://img.shields.io/github/issues/cyfrin/aderyn\n[issues-url]: https://github.com/cyfrin/aderyn/issues\n[license-shield]: https://img.shields.io/github/license/cyfrin/aderyn?logoColor=%23fff&color=blue\n[license-url]: https://github.com/cyfrin/aderyn/blob/master/LICENSE\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555\n","readmeFilename":"README.md"}
![\"\"/](\"https://github.com/Cyfrin/aderyn/blob/dev/.github/images/aderyn_logo.png\"){kind=logo}
\n ![\"\"/](\"https://github.com/Cyfrin/aderyn/blob/dev/.github/images/poweredbycyfrinblue.png\")
\n