Merge pull request #1097 from ConsenSys/docs/update_cli

Update docs after cli refactor
pull/1106/head
Bernhard Mueller 5 years ago committed by GitHub
commit 5448e48f68
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 4
      docs/source/installation.rst
  2. 10
      docs/source/security-analysis.rst

@ -57,10 +57,10 @@ Use :code:`docker run mythril/myth` the same way you would use the :code:`myth`
.. code-block:: bash
docker run mythril/myth --help
docker run mythril/myth -dc "0x6060"
docker run mythril/myth disassemble -c "0x6060"
To pass a file from your host machine to the dockerized Mythril, you must mount its containing folder to the container properly. For :code:`contract.sol` in the current working directory, do:
.. code-block:: bash
docker run -v $(pwd):/tmp mythril/myth -x /tmp/contract.sol
docker run -v $(pwd):/tmp mythril/myth analyze /tmp/contract.sol

@ -11,7 +11,7 @@ In order to work with Solidity source code files, the `solc command line compile
.. code-block:: bash
$ myth -x ether_send.sol
$ myth analyze ether_send.sol
==== Unprotected Ether Withdrawal ====
SWC ID: 105
Severity: High
@ -32,7 +32,7 @@ If an input file contains multiple contract definitions, Mythril analyzes the *l
.. code-block:: bash
myth -x OmiseGo.sol:OMGToken
myth analyze OmiseGo.sol:OMGToken
Specifying Solc Versions
########################
@ -47,7 +47,7 @@ By default, analysis results are printed to the terminal in text format. You can
.. code-block:: bash
myth -xo jsonv2 underflow.sol
myth analyze underflow.sol -o jsonv2
Available formats are :code:`text`, :code:`markdown`, :code:`json`, and :code:`jsonv2`. For integration with other tools, :code:`jsonv2` is generally preferred over :code:`json` because it is consistent with other `MythX <https://mythx.io>`_ tools.
@ -73,13 +73,13 @@ Analyze mainnet contract via INFURA:
.. code-block:: bash
myth -x -a 0x5c436ff914c458983414019195e0f4ecbef9e6dd
myth analyze -a 0x5c436ff914c458983414019195e0f4ecbef9e6dd
Adding the :code:`-l` flag will cause mythril to automatically retrieve dependencies, such as dynamically linked library contracts:
.. code-block:: bash
myth -xla 0xEbFD99838cb0c132016B9E117563CB41f2B02264 -v4
myth -v4 analyze -l -a 0xEbFD99838cb0c132016B9E117563CB41f2B02264
******************
Speed vs. Coverage

Loading…
Cancel
Save