Skip to content

Commit 86b513f

Browse files
authored
Merge pull request #4134 from AbrilRBS/ar/audit-sbom-lockfiles-docs
Add sbom and lockfile references to audit list
1 parent 03287a1 commit 86b513f

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

reference/commands/audit.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,26 @@ See :ref:`the audit devops page<devops_audit>` to see examples on how to use the
1313

1414

1515
conan audit scan
16-
================
16+
^^^^^^^^^^^^^^^^
1717

1818
.. autocommand::
1919
:command: conan audit scan -h
2020

21-
The ``conan audit scan`` checks for vulnerabilities in the given references and their transitive dependencies.
21+
The ``conan audit scan`` command checks for vulnerabilities in the given references and their transitive dependencies.
2222
This command receives configuration arguments such as profiles and settings, to control the expansion of the graph.
2323

2424
conan audit list
25-
================
25+
^^^^^^^^^^^^^^^^
2626

2727
.. autocommand::
2828
:command: conan audit list -h
2929

3030
The ``conan audit list`` command lists vulnerabilities for the given references, without checking their transitive dependencies.
31-
You can pass a single reference, or a pkglist file with multiple references.
31+
You can pass a single reference, a pkglist file with multiple references,
32+
a cyclonedx SBOM file generated with the :ref:`conan.tools.sbom <conan_tools_sbom>` module, or a Conan lockfile.
3233

3334
conan audit provider
34-
====================
35+
^^^^^^^^^^^^^^^^^^^^
3536

3637
.. autocommand::
3738
:command: conan audit provider -h
@@ -42,6 +43,7 @@ By default the ``conan audit`` subcommands use the ConanCenter provider, but you
4243
For now, besides the default ConanCenter provider, only private JFrog Security providers are supported, see :ref:`the audit devops page<devops_audit_private_providers>` for more information.
4344

4445
There are 3 subcommands:
46+
4547
- ``conan audit provider auth``: Authenticates a provider with a token.
4648
- ``conan audit provider add``: Adds a provider to the list.
4749
- ``conan audit provider remove``: Removes a provider from the list.

0 commit comments

Comments
 (0)