Skip to content

Commit bc1c655

Browse files
committed
Enhance description of the --from-json option #2562
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent a4d9219 commit bc1c655

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/source/cli-reference/core-options.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,20 @@ Comparing Progress Message Options
8484
This inputs the scan results from ``sample.json``, runs the post-scan plugin ``--classify`` and
8585
outputs the results for this scan to ``sample_2.json``.
8686

87+
You can also convert the input .json file to other output format
88+
without using any scan option.
89+
90+
For instance,::
91+
92+
scancode --from-json sample.json --yaml sample.yml
93+
94+
The above command takes ``sample.json`` as input and generates file in .yml formats.
95+
96+
.. note::
97+
98+
This only works for options that require only the input JSON file;
99+
options that rely on other files or source code will not work.
100+
87101
----
88102

89103
.. _max_in_memory_option:

0 commit comments

Comments
 (0)