Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,45 @@ useful. This includes:

## Installation

`spdx3-validate` can be installed using `pip`:
`spdx3-validate` can be installed using either `pip`
or [`pipx`](https://github.com/pypa/pipx):

```shell
python3 -m pip install spdx3-validate
```

or

```shell
pipx install spdx3-validate
```

## Usage

```shell
spdx3-validate -j sbom.json
```

### Options

All available options can be listed by this command:

```shell
spdx3-validate -h
```

```text
options:
-h, --help show this help message and exit
--json, -j JSON Validate SPDX 3 JSON file (URL, path, or '-')
--spdx-version, -s {3.0.0,3.0.1,auto}
SPDX Version to use, or 'auto' to determine version
from input files
--version, -V show program's version number and exit
--no-merge Do not validate merged documents
--quiet, -q Run quietly (do not show progress)
```

## Developing

Developing on `spdx3-validate` is best done using a virtual environment. You
Expand Down
Loading