![\"get](\"https://user-images.githubusercontent.com/2865694/56826101-91dcf380-685b-11e9-937c-af49c2510aa0.png\")
](https://diligence.consensys.net)\n \n [[ 🌐 ](https://diligence.consensys.net?utm_source=github_npm&utm_medium=banner&utm_campaign=surya) [ 📩 ](mailto:diligence@consensys.net) [ 🔥 ](https://consensys.github.io/diligence/)]\n \n
![](\"https://user-images.githubusercontent.com/4008213/39437435-bed48266-4c98-11e8-834d-1de152667231.jpg\")
\n\n\n\n [](https://diligence.consensys.net)
\n \n [[ 🌐 ](https://diligence.consensys.net?utm_source=github_npm&utm_medium=banner&utm_campaign=surya) [ 📩 ](mailto:diligence@consensys.net) [ 🔥 ](https://consensys.github.io/diligence/)]\n \n
![](\"https://user-images.githubusercontent.com/4008213/39415345-fbac4e3a-4c39-11e8-8260-0d9670c352d6.png\")
\n\nThere is new flag (`-s`/`--simple`) that amkes the command chart only the *contract* call graph, instead of the function call graph. It's super useful for higher-level analyses!\n\n**Accepted flags**\n\n* `-i`/`--import` - Resolve all imports automatically by fetching the right files.\n* `-c`/`--content` - Allow passing in file contents as arguments instead of file paths.\n* `-s`/`--simple` - Only show calls between contracts, without specifying the functions.\n* `-m`/`--modifiers` - **Enable** printing edges from functions to modifiers (when the latter are invoked in the function definitions).\n* `-l`/`--libraries` - **Disable** printing edges from functions to libraries when the \"Using ... for\" syntax is in use (to prevent libraries like SafeMath from polluting the call graph).\n\n### ftrace\n\nThe `ftrace` command outputs a _treefied_ function call trace stemming from the defined \"CONTRACT::FUNCTION\" and traversing \"all|internal|external\" types of calls.\nExternal calls are marked in `orange` and internal calls are `uncolored`.\n\n```shell\nsurya ftrace APMRegistry::_newRepo all MyContract.sol\n```\n\n![](\"https://user-images.githubusercontent.com/4008213/42409007-61473d12-81f1-11e8-8fee-1867cfd66822.png\")
\n\n**Accepted flags**\n\n* `-i`/`--import` - Resolve all imports automatically by fetching the right files.\n* `-c`/`--content` - Allow passing in file contents as arguments instead of file paths.\n* `-j`/`--json` - Return a JSON object instead of a _treefied_ function call trace (mostly useful when Surya is being used as another package's dependency).\n\n### flatten\n\nThe `flatten` command outputs a flattened version of the source code, with all import statements replaced by the corresponding source code. Import statements that reference a file that has already been imported, will simply be commented out. \n\n```shell\nsurya flatten MyContract.sol\n```\n\n### describe\n\nThe `describe` command shows a summary of the contracts and methods in the files provided.\n\n```shell\nsurya describe *.sol\n```\n\n![](\"https://user-images.githubusercontent.com/4008213/48572168-97bfc780-e900-11e8-9e86-d265498de936.png\")
\n\nFunctions will be listed as:\n\n* `[Pub]` public\n* `[Ext]` external\n* `[Prv]` private\n* `[Int]` internal\n\nA yellow `($)`denotes a function is `payable`.\n\nA red `#` indicates that it's able to modify state.\n\n**Accepted flags**\n\n* `-i`/`--import` - Resolve all imports automatically by fetching the right files.\n* `-c`/`--content` - Allow passing in file contents as arguments instead of file paths.\n\n### inheritance\n\nThe `inheritance` command outputs a DOT-formatted graph of the inheritance tree. For Windows machines, the `>` should be replaced with `-o`.\n\n```shell\nsurya inheritance MyContract.sol | dot -Tpng > MyContract.png\n```\n\n![](\"https://user-images.githubusercontent.com/23033765/39249140-f50d2828-486b-11e8-81b8-8c4ffb7b1b54.png\")
\n\n**Accepted flags**\n\n* `-i`/`--import` - Resolve all imports automatically by fetching the right files.\n* `-c`/`--content` - Allow passing in file contents as arguments instead of file paths.\n\n### dependencies\n\nThe `dependencies` command outputs the [c3-linearization](https://en.wikipedia.org/wiki/C3_linearization) of a given contract's inheritance graph. Contracts will be listed starting with most-derived, ie. if the same function is defined in more than one contract, the solidity compiler will use the definition in whichever contract is listed first. \n\n```shell\nsurya dependencies Exchange Exchange.sol\n```\n\n**Accepted flags**\n\n* `-i`/`--import` - Resolve all imports automatically by fetching the right files.\n* `-c`/`--content` - Allow passing in file contents as arguments instead of file paths.\n\n### parse\n\nThe `parse` command outputs a _treefied_ AST object coming from the parser.\n\n**Accepted flags**\n\n* `-j`/`--json` - Return a JSON object instead of a _treefied_ object.\n\n```shell\nsurya parse MyContract.sol\n```\n\n![](\"https://user-images.githubusercontent.com/4008213/39415303-87df40de-4c39-11e8-8e03-ead72e88f1e3.png\")
\n\n\n### mdreport\n\nThe `mdreport` command creates a Markdown description report with tables comprising information about the system's files, contracts and their functions. Much like describe but outputting to a nicely formatted Markdown file.\n\n```shell\nsurya mdreport report_outfile.md MyContract.sol\n```\n\n\n\n## License\n\nGPL-3.0\n\n## Kudos\n\nCreated by @federicobond extended by @GNSPS\n","readmeFilename":"README.md","author":{}}