Skip to content

Commit

Permalink
Fix command Usage
Browse files Browse the repository at this point in the history
This changes the cmd Usage text to accurately represents the
supported syntax:

Usage:
  ./scorecard (--repo=<repo_url> | --local=<folder> | --{npm,pypi,rubygems}=<package_name> ) [--checks=check1,...]
	 [--show-details] [flags]

Signed-off-by: Arnaud J Le Hors <lehors@us.ibm.com>
  • Loading branch information
lehors committed Apr 4, 2022
1 parent 648b663 commit 3f175f6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
5 changes: 2 additions & 3 deletions cmd/root.go
Expand Up @@ -37,9 +37,8 @@ import (

const (
scorecardLong = "A program that shows security scorecard for an open source software."
scorecardUse = `./scorecard [--repo=<repo_url>] [--local=folder] [--checks=check1,...]
[--show-details] or ./scorecard --{npm,pypi,rubygems}=<package_name>
[--checks=check1,...] [--show-details]`
scorecardUse = `./scorecard (--repo=<repo_url> | --local=<folder> | --{npm,pypi,rubygems}=<package_name> ) [--checks=check1,...]
[--show-details]`
scorecardShort = "Security Scorecards"
)

Expand Down
2 changes: 1 addition & 1 deletion options/flags.go
Expand Up @@ -73,7 +73,7 @@ func (o *Options) AddFlags(cmd *cobra.Command) {
&o.Repo,
FlagRepo,
o.Repo,
"repository to check",
"URL of repository to check",
)

cmd.Flags().StringVar(
Expand Down

0 comments on commit 3f175f6

Please sign in to comment.