mirror of
https://github.com/valitydev/rebar3_sbom.git
synced 2024-11-06 00:35:19 +00:00
Improve README
This commit is contained in:
parent
5cffe465e4
commit
d4f254012f
24
README.md
24
README.md
@ -1,24 +1,30 @@
|
||||
rebar3_sbom
|
||||
=====
|
||||
===========
|
||||
|
||||
Generates a Software Bill-of-Materials (SBoM) in CycloneDX format
|
||||
|
||||
Build
|
||||
-----
|
||||
|
||||
$ rebar3 compile
|
||||
|
||||
Use
|
||||
---
|
||||
|
||||
Add the plugin to your rebar config, either in a project or globally in
|
||||
Add rebar3_sbom to your rebar config, either in a project or globally in
|
||||
~/.config/rebar3/rebar.config:
|
||||
|
||||
{plugins, [rebar3_sbom]}.
|
||||
|
||||
Then just call your plugin directly in an existing application:
|
||||
|
||||
Then run the 'sbom' task on a project:
|
||||
|
||||
$ rebar3 sbom
|
||||
===> Verifying dependencies...
|
||||
===> CycloneDX SBoM written to bom.xml
|
||||
|
||||
The following command line options are supported:
|
||||
|
||||
-o, --output the full path to the SBoM output file [default: bom.xml]
|
||||
-f, --force overwite existing files without prompting for confirmation
|
||||
[default: false]
|
||||
|
||||
By default only dependencies in the 'default' profile are included. To
|
||||
generate an SBoM covering development environments specify the relevant
|
||||
profiles using 'as':
|
||||
|
||||
$ rebar3 as default,test,docs sbom -o dev_bom.xml
|
||||
|
Loading…
Reference in New Issue
Block a user