SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 05:40:11 +01:00
Code Issues Releases Activity Actions

Improve docs

Browse source 
* Add --help from ./csaf_checker --version 0.3.1-8-gd5d48c7
This commit is contained in:
Bernhard Reiter 2022-05-16 16:32:49 +02:00
parent baea1eb134
commit cac8f6c427
No known key found for this signature in database
GPG key ID: 2B7BA3BF9BC3A554
1 changed files with 15 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/csaf_checker.md
View file

@ -1,16 +1,21 @@
## csaf_checker
Following options are supported:
### Usage
| Options | Description |
| ------------------------------------------ | ---------------------------------------------- |
| -o, --output=REPORT-FILE | File name of the generated report |
| -f, --format=[json | html] |
| -t, --tlp=[csaf\|white\|green\|amber\|red] | Format of report (default: json) |
| --insecure | o not check TLS certificates from provider |
| --client-cert=CERT-FILE | TLS client certificate file (PEM encoded data) |
| --client-key=KEY-FILE | TLS client private key file (PEM encoded data) |
| --version | Display version of the binary |
```
csaf_checker [OPTIONS]
Application Options:
-o, --output=REPORT-FILE File name of the generated report
-f, --format=[json|html] Format of report (default: json)
--insecure Do not check TLS certificates from provider
--client-cert=CERT-FILE TLS client certificate file (PEM encoded data)
--client-key=KEY-FILE TLS client private key file (PEM encoded data)
--version Display version of the binary
Help Options:
-h, --help Show this help message
```
Usage example:
` ./csaf_checker example.com -f html -o check-results.html`