To install the surya utility tool on your machine, run the following command:
$ npm install -g surya
Once this is installed, you can use the surya command in any of your truffle projects or even in the folders containing Solidity files.
surya provides the following commands:
- surya describe: This generates the contract structure in text format
- surya graph: This generates the flow graph of the function calls
- surya inheritance: This generates the contract inheritance graph
- surya dependencies: This generates the C3 linearization of inherited contracts
- surya parse: This parses and generates an Abstract Syntax Tree (AST) tree in text format
- surya ftrace: This generates the function trace of a given function name
- surya mdreport ...