Skip to content

Commit 574e277

Browse files
committed
Add a "run-scan.sh" usage example in the FAQ
Signed-off-by: tdruez <[email protected]>
1 parent 5a5b33f commit 574e277

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

docs/faq.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ you may use the Docker image to run pipelines as a single command:
2929
3030
Refer to the :ref:`cli_run` section for more about this approach.
3131

32+
.. tip::
33+
Prefer a one-liner? Use this to scan your current directory::
34+
35+
curl -sSL https://raw.githubusercontent.com/aboutcode-org/scancode.io/main/etc/scripts/run-scan.sh | bash
36+
3237
.. _faq_which_pipeline:
3338

3439
Which pipeline should I use?

docs/quickstart.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ The **fastest way** to get started and **scan a codebase** —
1515
Visit the `Docker documentation <https://docs.docker.com/get-docker/>`_ to install
1616
it for your platform.
1717

18-
To run the :ref:`pipeline_scan_codebase` pipeline on a local directory
19-
with a single command:
18+
To run the :ref:`pipeline_scan_codebase` pipeline on a **local directory**
19+
with a **single command**:
2020

2121
.. code-block:: bash
2222
@@ -47,9 +47,9 @@ Let's unpack what each part of the command does:
4747

4848
The result? A **full scan of your local directory — no setup, one command!**
4949

50-
See the :ref:`$ run <cli_run>` section for more details on this command.
50+
See the :ref:`RUN command <cli_run>` section for more details on this command.
5151

52-
.. tip::
52+
.. note::
5353
Not sure which pipeline to use? Check out :ref:`faq_which_pipeline`.
5454

5555
Next Step: Local Installation

0 commit comments

Comments
 (0)