echidna icon indicating copy to clipboard operation
echidna copied to clipboard

Add CLI command to generate sample config

Open arcz opened this issue 2 years ago • 0 comments

This changes the CLI interface of Echidna by adding echidna init command that generates a sample echidna.yaml config and moves the current fuzzing interface to echidna fuzz ... command:

Echidna

Usage: echidna [--version] COMMAND

  EVM property-based testing framework

Available options:
  -h,--help                Show this help text
  --version                Show version

Available commands:
  init                     Write a sample config file to echidna.yaml
  fuzz                     Run fuzzing

I reused the existing tests/solidity/basic/default.yaml, which already contains all the config options up to date. I polished the contents by separating config options into logical groups and improved the descriptions. This file still requires work to be more user-friendly.

Additional ideas to consider:

  • Load the echidna.yaml config by default
  • Add path to echidna init <path>

Closes https://github.com/crytic/echidna/issues/940

arcz avatar Jul 22 '23 14:07 arcz