Skip to content

Commit

Permalink
docs: update binary name to match "--help" output
Browse files Browse the repository at this point in the history
  • Loading branch information
zdtsw committed Dec 9, 2022
1 parent 5de8d19 commit f337b54
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ The CycloneDX CLI tool currently supports BOM analysis, modification, diffing, m

Conversion is supported between CycloneDX XML, JSON, Protobuf, CSV, and SPDX JSON v2.2.

Binaries can be downloaded from the [releases page](https://github.com/CycloneDX/cyclonedx-cli/releases).
Binaries can be downloaded from the [releases page](https://github.com/CycloneDX/cyclonedx-cli/releases). It is better to rename binaries to "cyclonedx" before execution as CLI.

Note: The CycloneDX CLI tool is built for automation use cases. Any commands that have the `--input-file` option also support feeding input from stdin. Likewise, any commands that have the `--output-file` option support output to stdout. However, you will need to supply the input/output formats.

For example:
`cat bom.json | cyclonedx-cli convert --input-format json --output-format xml > bom.xml`
`cat bom.json | cyclonedx convert --input-format json --output-format xml > bom.xml`

# Commands

Expand Down Expand Up @@ -70,10 +70,10 @@ Options:
#### Examples

Generating a source code BOM, excluding Git repository directory:
`cyclonedx-cli add files --no-input --output-format json --exclude /.git/**`
`cyclonedx add files --no-input --output-format json --exclude /.git/**`

Adding build output files, from `bin` directory, to existing BOM:
`cyclonedx-cli add files --input-file bom.json --output-format json --base-path bin`
`cyclonedx add files --input-file bom.json --output-format json --base-path bin`

## Analyze Command

Expand All @@ -94,7 +94,7 @@ Options:
### Examples

Reporting on components that are included multiple times with different versions:
`cyclonedx-cli analyze --input-file sbom.xml --multiple-component-versions`
`cyclonedx analyze --input-file sbom.xml --multiple-component-versions`

## Convert Command

Expand All @@ -116,10 +116,10 @@ Options:
### Examples

Converting from XML to JSON format:
`cyclonedx-cli convert --input-file sbom.xml --output-file sbom.json`
`cyclonedx convert --input-file sbom.xml --output-file sbom.json`

Converting from XML to JSON format and piping output to additional tools:
`cyclonedx-cli convert --input-file sbom.xml --output-format json | grep "somthing"`
`cyclonedx convert --input-file sbom.xml --output-format json | grep "somthing"`

### CSV Format

Expand Down Expand Up @@ -166,7 +166,7 @@ Options:
### Examples

Reporting on components with version changes:
`cyclonedx-cli diff sbom-from.xml sbom-to.xml --component-versions`
`cyclonedx diff sbom-from.xml sbom-to.xml --component-versions`

## Keygen Command

Expand Down Expand Up @@ -208,10 +208,10 @@ described in the metadata component element.
### Examples

Merge two XML formatted BOMs:
`cyclonedx-cli merge --input-files sbom1.xml sbom2.xml --output-file sbom_all.xml`
`cyclonedx merge --input-files sbom1.xml sbom2.xml --output-file sbom_all.xml`

Merging two BOMs and piping output to additional tools:
`cyclonedx-cli merge --input-files sbom1.xml sbom2.xml --output-format json | grep "something"`
`cyclonedx merge --input-files sbom1.xml sbom2.xml --output-format json | grep "something"`

## Sign Command

Expand Down Expand Up @@ -269,7 +269,7 @@ Options:
### Examples

Validate BOM and return non-zero exit code (handy for automatically "breaking" a build, etc)
`cyclonedx-cli validate --input-file sbom.xml --fail-on-errors`
`cyclonedx validate --input-file sbom.xml --fail-on-errors`

## Verify Command

Expand Down Expand Up @@ -310,14 +310,14 @@ Options:

# Docker Image

The CycloneDX CLI tool can also be run using docker `docker run cyclonedx/cyclonedx-cli`.
The CycloneDX CLI tool can also be run using docker `docker run cyclonedx/cyclonedx`.

# Homebrew

For Linux and MacOS, the CLI can be installed via the [CycloneDX Homebrew tap](https://github.com/CycloneDX/homebrew-cyclonedx):

```shell
brew install cyclonedx/cyclonedx/cyclonedx-cli
brew install cyclonedx/cyclonedx/cyclonedx
```

# Supported Platforms
Expand Down

0 comments on commit f337b54

Please sign in to comment.