Skip to content

Commit

Permalink
Update fosslight_scanner parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
soimkim authored Sep 24, 2024
1 parent 6035f2c commit 5c47b6c
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions scanner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ $ fosslight [Mode] [option1] <arg1> [option2] <arg2>...
```
```
Parameters:
Mode
Mode: Multiple modes can be entered by separating them with , (ex. source,binary)
all Run all scanners(Default)
source Run FOSSLight Source Scanner
dependency Run FOSSLight Dependency Scanner
Expand All @@ -53,23 +53,26 @@ $ fosslight [Mode] [option1] <arg1> [option2] <arg2>...
-w <link> Link to be analyzed can be downloaded by wget or git clone
-f <format> FOSSLight Report file format (excel, yaml)
* Compare mode result file: supports excel, json, yaml, html
-e <path> Path to exclude from analysis (ex, -e {dir} {file})
-o <output> Output directory or file
-c <number> Number of processes to analyze source
-r Keep raw data
-t Hide the progress bar
-v Print FOSSLight Scanner version
-s <path> Path to apply setting from file (check format with 'setting.json' in this repository)
* Direct cli flags have higher priority than setting file
(ex, '-f yaml -s setting.json' - result file extension is .yaml)
(ex, '-f yaml -s setting.json' - result file extension is .yaml)
--no_correction Enter if you don't want to correct OSS information with sbom-info.yaml
* Correction mode only supported xlsx format.
--correct_fpath <path> Path to the sbom-info.yaml file
--ui Generate UI mode result file
Options for only 'all' or 'bin' mode
-u <db_url> DB Connection(format :'postgresql://username:password@host:port/database_name')
Options for only 'all' or 'dependency' mode
-d <dependency_argument> Additional arguments for running dependency analysis
```
- Enter the -d option only when argument input is required when running FOSSLight Dependency. : [Refer FOSSLight Dependency guide](3_dependency.md)

Expand Down

0 comments on commit 5c47b6c

Please sign in to comment.