03-u-getting-started.md 629 B


id: 03-u-getting-started title: Getting started

sidebar_label: Getting started

The tool is relatively simple to use. There are 3 fundamental steps:

  • Collect the data, for example:

    > python "/path/to/metrix++.py" collect --std.code.lines.code --std.code.complexity.cyclomatic
    
  • View the data, for example:

    > python "/path/to/metrix++.py" view
    
  • Apply thresholds, for example:

    > python "/path/to/metrix++.py" limit --max-limit=std.code.complexity:cyclomatic:7
    

Please, check the advanced description of the workflow with real examples.