Skip to content

README.md

Latest commit

 

History

History
37 lines (25 loc) · 1.38 KB

README.md

File metadata and controls

37 lines (25 loc) · 1.38 KB

Table of Contents

Usage

yarn analyze <BASE_PATH> -s <SCOPE_FILE> -g <GITHUB_URL> -o <OUTPUT_FILE>

# Example
yarn analyze contracts -s scope.example.txt -g githubLink.com -o outfile.md
  • BASE_PATH is a relative path to the folder containing the smart contracts.
  • SCOPE_FILE is an optional file containg a specific smart contracts scope (see scope.example.txt)
  • GITHUB_URL is an optional url to generate links to github in the report
  • OUTPUT_FILE is an optional file name where the output will be saved , by default it's saved in report.md file.

Example Reports

Repository Report
Ens Report

Installation

You'll need Node.js and Yarn. Then clone the repo and run:

yarn

You're all set!