config.rst

The Configuration File

You can modify Brownie's default behaviours by creating an optional configuration file.

The configuration file must be saved as brownie-config.yaml. If saved in the root directory of a project it will be loaded whenever that project is active. If saved in your home path, it will always be loaded.

All configuration fields are optional. You can copy from the examples below and modify the settings as required.

Default Configuration

The following example shows all configuration settings and their default values:

../brownie/data/default-config.yaml

Settings

Project Structure

Project subdirectory names. Include these fields if you wish to modify the default structure of your project.

Networks

Compiler

Compiler settings. See compiler settings<compile_settings> for more information.

Console

Reports

Settings related to reports such as coverage data and gas profiles.

Hypothesis

Default settings for property-based<hypothesis> and stateful<hypothesis-stateful> test execution. See the Hypothesis settings documentation for a complete list of available settings.

hypothesis:
    deadline: null
    max_examples: 50
    report_multiple_bugs: False
    stateful_step_count: 10
    deadline: null
    phases:
        explicit: true
        reuse: true
        generate: true
        target: true
        shrink: true

Other Settings