checkov_programmatic_directory_scan_with_runner_filter.py

1from checkov.main import CheckovMain
2from checkov.common.runners.runner_factory import RunnerFactory
3from checkov.runner_filter import RunnerFilter
4
5def run_checkov():
6    # Initialize the Checkov main class
7    ckv_main = CheckovMain()
8    
9    # Define the directory to scan (current directory in this example)
10    source_dir = ["."]
11    
12    # Configure the runner filter (e.g., skip specific checks or framework filtering)
13    runner_filter = RunnerFilter(framework=['terraform', 'cloudformation', 'kubernetes'])
14
15    # Execute the scan
16    # Note: In a script execution, CheckovMain.run() typically handles CLI args.
17    # To run programmatically within a script, you can invoke the runner factory directly:
18    root_folder = "."
19    runner_factory = RunnerFactory()
20    report = runner_factory.run(
21        root_folder=root_folder,
22        runner_filter=runner_filter
23    )
24
25    # Print results to console
26    for r in report:
27        if r:
28            r.print_console()
29
30if __name__ == "__main__":
31    run_checkov()