Skip to content

Commit eb19d6f

Browse files
authored
Update README.md
1 parent 7da8419 commit eb19d6f

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -62,25 +62,27 @@ fosslight [Mode] [option1] <arg1> [option2] <arg2>...
6262
### Parameters
6363
Mode
6464
```
65-
source Run FOSSLight Source
66-
dependency Run FOSSLight Dependency
67-
binary Run FOSSLight Binary
68-
prechecker Run FOSSLight Prechecker
69-
all Run all scanners
65+
source Run FOSSLight Source
66+
dependency Run FOSSLight Dependency
67+
binary Run FOSSLight Binary
68+
prechecker Run FOSSLight Prechecker
69+
all Run all scanners
70+
compare Compare two FOSSLight reports
7071
```
7172
Options:
7273
```
73-
-h Print help message
74-
-r Keep raw data
75-
-t Hide the progress bar
76-
-v Print FOSSLight Scanner version
77-
-p <path> Path to analyze source
78-
-w <link> Link to be analyzaed can be downloaded by wget or git clone
79-
-o <output> Output Directory or file
80-
-f <format> Output file format (excel, csv, opossum)
81-
-c <cores> Number of processes to analyze source
82-
-d <additional_arg> Additional arguments for running dependency analysis
83-
-u <db_url> DB Connection(format :'postgresql://username:password@host:port/database_name')
74+
-h Print help message
75+
-p <path> Path to analyze (ex, -p {input_path})
76+
* Compare mode input file: Two FOSSLight reports (supports excel, yaml)
77+
(ex, -p {before_name}.xlsx {after_name}.xlsx)
78+
-w <link> Link to be analyzed can be downloaded by wget or git clone
79+
-f <format> FOSSLight Report file format (excel, yaml)
80+
* Compare mode result file: supports excel, json, yaml, html
81+
-o <output> Output directory or file
82+
-c <number> Number of processes to analyze source
83+
-r Keep raw data
84+
-t Hide the progress bar
85+
-v Print FOSSLight Scanner version
8486
```
8587
- Refs.
8688
- Additional arguments for running dependency analysis. See the [FOSSLight Dependency Guide][fd_guide] for instructions.
@@ -99,6 +101,11 @@ $ fosslight all -p /home/source_path -d "-a 'source /test/Projects/venv/bin/acti
99101
$ fosslight all -o test_result_wget -w "https://github.com/LGE-OSS/example.git"
100102
```
101103

104+
### Ex 3. Compare the BOM of two FOSSLight reports with yaml or excel format and check the oss status (change/add/delete)
105+
```
106+
$ fosslight compare -p FOSSLight_before_proj.yaml FOSSLight_after_proj.yaml -f excel
107+
```
108+
102109
## 📁 Result
103110

104111
```

0 commit comments

Comments
 (0)