Updated arguments

pull/2278/head
Vishnuram Rajkumar 10 months ago
parent 799117d086
commit 5fb5f69b8e
  1. 6
      slither/tools/mutator/README.md
  2. 4
      slither/tools/mutator/__main__.py

@ -4,24 +4,24 @@
## Usage
`slither-mutate <codebase> <test-cmd> <options>`
`slither-mutate <codebase> --test-cmd <test-command> <options>`
### CLI Interface
```
positional arguments:
codebase Codebase to analyze (.sol file, truffle directory, ...)
test-cmd Command to run the tests for your project
options:
-h, --help show this help message and exit
--list-mutators List available detectors
--test-cmd TEST_CMD Command to run the tests for your project
--test-dir TEST_DIR Tests directory
--ignore-dirs IGNORE_DIRS
Directories to ignore
--timeout TIMEOUT Set timeout for test command (by default 30 seconds)
--output-dir OUTPUT_DIR
Name of output Directory (by default 'mutation_campaign')
Name of output directory (by default 'mutation_campaign')
--verbose output all mutants generated
--mutators-to-run MUTATORS_TO_RUN
mutant generators to run

@ -26,7 +26,7 @@ logger.setLevel(logging.INFO)
def parse_args() -> argparse.Namespace:
parser = argparse.ArgumentParser(
description="Experimental smart contract mutator. Based on https://arxiv.org/abs/2006.11597",
usage="slither-mutate target",
usage="slither-mutate <codebase> --test-cmd <test command> <options>",
)
parser.add_argument("codebase", help="Codebase to analyze (.sol file, truffle directory, ...)")
@ -41,7 +41,7 @@ def parse_args() -> argparse.Namespace:
# argument to add the test command
parser.add_argument(
"test-cmd",
"--test-cmd",
help="Command to run the tests for your project"
)

Loading…
Cancel
Save