Skip to content

Commit ab1932a

Browse files
committed
Update cli-core-options.rst #3941 #5289
Signed-off-by: Jono Yang <jyang@nexb.com>
1 parent 60ee685 commit ab1932a

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,32 @@ Comparing progress message options
196196

197197
----
198198

199+
.. _cli-use-cached-results-option:
200+
201+
``--use-cached-results``
202+
------------------------
203+
204+
When enabled, during scan time for a given Resource, we iterate through the
205+
active scanners and see if we have cached results for those already. If we
206+
do, we update our results with the cached data. If not, we add those
207+
scanners to a list of scanners to be run. After scanning, the cache is
208+
updated.
209+
210+
**Example**
211+
212+
.. code-block:: shell
213+
214+
scancode -clipeu --use-cached-results samples samples.json
215+
216+
On the first run, the cache will be created for the scanned Resources in
217+
`samples`. Subsequent runs on `samples` will return cached results.
218+
219+
When run as a stand-alone release, the results cache is tied to specific
220+
ScanCode toolkit versions. When run in development mode, the cache is stored
221+
in the `scancode-toolkit/.cache` directory.
222+
223+
----
224+
199225
.. _glob-pattern-matching:
200226

201227
Glob Pattern Matching

0 commit comments

Comments
 (0)