https://github.com/apicurio/apicurio-cve-cli

https://github.com/apicurio/apicurio-cve-cli

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/apicurio/apicurio-cve-cli
• Owner: Apicurio
• Created: 2022-10-04T13:13:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-22T17:54:38.000Z (almost 2 years ago)
• Last Synced: 2024-11-05T10:47:51.652Z (3 months ago)
• Language: Go
• Size: 31.3 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Apicurio CVE Helper

CLI tooling that helps with managing JIRA CVE reports

**WARNING:** Project is still WORK IN PROGRESS and currently supports only Apicurio Team CVEs.

# Build

You can build project using this command:

```

$ go build

```

To install cli to your path use:

```

$ go install

```

# Usage

```

[msafar@redhat]$ apicurio-cve-helper

Apicurio CVE helper - a simple CLI to manage CVE reports

Usage:

  apicurio-cve-helper [command]

Available Commands:

  completion  Generate the autocompletion script for the specified shell

  help        Help about any command

  issues      Manage Jira issues

Flags:

  -h, --help      help for apicurio-cve-helper

  -v, --version   version for apicurio-cve-helper

Use "apicurio-cve-helper [command] --help" for more information about a command.

```

## Configuration

Configuration file config.yml can be located at `./config.yml` or at `~/.config/apicurio-cve-helper/config.yml`

Example config.yml

```yaml

jira_token: sdauyv4234234fs1dg46go8mnazljy4

project_name: MGDSR

```

## Jira Authentication Token

To use Apicurio CVE helper you need to configure your jira token. You can do it using env variable `JIRA_TOKEN` or in the config.yml.

```

$ export JIRA_TOKEN=

```

## Get all opened CVEs

```

$ apicurio-cve-helper issues get --sbom 

```

## Formatting

Tool supports tree types of output: `json`, `html` and default `text`. You can use `json` format using `--json` flag and `html` using `--html` flag:

```

$ apicurio-cve-helper issues get --sbom  --json

```

```

$ apicurio-cve-helper issues get --sbom  --html

```