# aderyn-docs

> Static analysis tool aderyn.

- [What is Aderyn?](https://aderyn.cyfrin.io/overview): /aˈdɛrɪn/ - Welsh (noun) - Bird. A member of the class of animals Aves in the phylum Chordata.
- [Installation](https://aderyn.cyfrin.io/installation): Install Aderyn on your system
- [Quickstart](https://aderyn.cyfrin.io/quickstart): Get started with Aderyn in minutes
- [CLI Options](https://aderyn.cyfrin.io/cli-options): Below are options which may be included with the aderyn CLI command.
- [What is Aderyn VS Code extension?](https://aderyn.cyfrin.io/vs-code/what-is-aderyn-vs-code-extension): Fast, real-time security checks for Solidity development
- [Installation & Usage](https://aderyn.cyfrin.io/vs-code/installation-and-usage): Set up the Aderyn VS Code extension
- [What is Aderyn CI Assistant?](https://aderyn.cyfrin.io/ci-assistant/what-is-aderyn-ci-assistant): Automated Solidity security analysis in GitHub Actions
- [Using the config file - aderyn.toml](https://aderyn.cyfrin.io/configuration/using-the-config-file): Customize Aderyn with aderyn.toml configuration
- [Source code directives to ignore lines](https://aderyn.cyfrin.io/configuration/source-code-directives): Use inline comments to suppress Aderyn warnings
- [List of Supported Detectors](https://aderyn.cyfrin.io/configuration/supported-detectors): Complete list of Aderyn's 90+ security detectors
- [What is an AST?](https://aderyn.cyfrin.io/internals/what-is-an-ast): Abstract Syntax Tree - structured representation of code
- [Detector](https://aderyn.cyfrin.io/internals/what-is-a-detector): How Aderyn detectors find vulnerabilities
- [Guide to create custom detectors](https://aderyn.cyfrin.io/internals/custom-detectors-guide): Step-by-step guide to building custom Aderyn detectors
- [Detectors API Reference](https://aderyn.cyfrin.io/internals/detectors-api-reference/index): Complete API reference for building custom detectors
- [detect](https://aderyn.cyfrin.io/internals/detectors-api-reference/detect): Function used to detect vulnerabilities
- [capture](https://aderyn.cyfrin.io/internals/detectors-api-reference/capture): Macro to capture vulnerability instances
- [title](https://aderyn.cyfrin.io/internals/detectors-api-reference/title): Set the title of the vulnerability in the report
- [description](https://aderyn.cyfrin.io/internals/detectors-api-reference/description): Provide detailed description of the vulnerability
- [severity](https://aderyn.cyfrin.io/internals/detectors-api-reference/severity): Define the severity level of the issue
- [name](https://aderyn.cyfrin.io/internals/detectors-api-reference/name): Return the detector name
- [instances](https://aderyn.cyfrin.io/internals/detectors-api-reference/instances): Get found vulnerability instances
- [WorkspaceContext](https://aderyn.cyfrin.io/internals/detectors-api-reference/workspacecontext): AST navigation and access API
- [Testing Your Detector](https://aderyn.cyfrin.io/internals/testing-your-detector): Write tests for custom detectors
- [Useful Detector Patterns](https://aderyn.cyfrin.io/internals/useful-detector-patterns): Common AST traversal techniques