How to run: CLI Usage

CLI general description

TP Framework can be used through a CLI:

tpframework [OPTIONS] COMMAND

To see the list for both mandatory and optional arguments, for each specific COMMAND type:

tpframework COMMAND --help

The following main commands are currently implemented:

add: add a pattern
measure: measure SAST tools against patterns
discovery: discover patterns in project source code
- discovery: discover measured patterns within a project source code
- manual-discovery: execute discovery rules (normally associated to patterns) within a project source code
reporting: create reports about SAST measurement and/or pattern discovery (CONTINUE)
- sastreport: fetch last SAST measurements for tools against patterns and aggregate in a common csv file
patternrepair: Can repair a pattern in your pattern library, i.e. checks the JSON file, creates a README file etc.

The following are under-investigation:

update: update a pattern (to be implemented)
scan: scan a project source code (to be implemented)
remediation: remediate a pattern via code transformations, SAST custom rules, ... (to be implemented)