Scan command shows error

[RituRajSingh878]

Scan for all clues:

To scan for licenses, copyrights, urls, emails, package information, and file information

./scancode -clip -e -u --format html-app samples samples.html
Scan for license and copyright clues:

./scancode -cl --format html-app samples samples.html

Scan for emails and URLs:
./scancode -e -u --format html-app samples samples.html

Scan for package information:

./scancode -p --format html-app samples samples.html

Scan for file information:

./scancode -i --format html-app samples samples.html

To see more example scans:

./scancode --examples

All these commands are showing an error.

(base) rituraj@rituraj-G7-7588:~/Documents/git/scancode-toolkit$ ./scancode -clip -e -u --format html-app samples samples.html
Error: no such option: --format

I think --format is an additional option to the command.

[steven-esser]

@RituRajSingh878 These command examples are out of date. See https://github.com/nexB/scancode-toolkit#installation for details. We have moved to a different syntax for output formats that are specified explicitly (see scancode --help for more details:

output formats:
    --json FILE             Write scan output as compact JSON to FILE.
    --json-pp FILE          Write scan output as pretty-printed JSON to FILE.
    --json-lines FILE       Write scan output as JSON Lines to FILE.
    --csv FILE              Write scan output as CSV to FILE.
    --html FILE             Write scan output as HTML to FILE.
    --custom-output FILE    Write scan output to FILE formatted with the custom
                            Jinja template file.
    --custom-template FILE  Use this Jinja template FILE as a custom template.
    --spdx-rdf FILE         Write scan output as SPDX RDF to FILE.
    --spdx-tv FILE          Write scan output as SPDX Tag/Value to FILE.
    --html-app FILE         (DEPRECATED: use the ScanCode Workbench app instead
                            ) Write scan output as a mini HTML application to
                            FILE.

[RituRajSingh878]

@MaJuRG thanks for your reply.
I am trying to modify doc, but no one is responding, and also I have already raised a pr #21 and aboutcode-org/scancode-toolkit#1574 for this. So please have a look and let me know. Also, I have built an issue #22, and I think it's a problem and we should not just commit from wiki without modifying it.

[RituRajSingh878]

@RituRajSingh878 These command examples are out of date. See https://github.com/nexB/scancode-toolkit#installation for details. We have moved to a different syntax for output formats that are specified explicitly (see scancode --help for more details:

output formats:
    --json FILE             Write scan output as compact JSON to FILE.
    --json-pp FILE          Write scan output as pretty-printed JSON to FILE.
    --json-lines FILE       Write scan output as JSON Lines to FILE.
    --csv FILE              Write scan output as CSV to FILE.
    --html FILE             Write scan output as HTML to FILE.
    --custom-output FILE    Write scan output to FILE formatted with the custom
                            Jinja template file.
    --custom-template FILE  Use this Jinja template FILE as a custom template.
    --spdx-rdf FILE         Write scan output as SPDX RDF to FILE.
    --spdx-tv FILE          Write scan output as SPDX Tag/Value to FILE.
    --html-app FILE         (DEPRECATED: use the ScanCode Workbench app instead
                            ) Write scan output as a mini HTML application to
                            FILE.

I will update you as soon as possible.

[steven-esser]

Thanks to @AyanSinhaMahapatra, #27 has been merged. The CLI docs should now be up to date with the latest v3.1.1 scancode-toolkit release candidate.