Skip to content

Commit

Permalink
📖 Fix command Usage (#1814)
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> | --local=<folder> | --{npm,pypi,rubygems}=<package_name>)
	 [--checks=check1,...] [--show-details] [flags]
...
      --repo string        repository to check (valid inputs: "owner/repo", "github.com/owner/repo", "https://github.com/owner/repo")
...

Signed-off-by: Arnaud J Le Hors <[email protected]>
  • Loading branch information
lehors authored May 9, 2022
1 parent 815de18 commit 6d79817
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
3 changes: 1 addition & 2 deletions cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ 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>
scorecardUse = `./scorecard (--repo=<repo> | --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
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func (o *Options) AddFlags(cmd *cobra.Command) {
&o.Repo,
FlagRepo,
o.Repo,
"repository to check",
"repository to check (valid inputs: \"owner/repo\", \"github.com/owner/repo\", \"https://github.com/repo\")",
)

cmd.Flags().StringVar(
Expand Down

0 comments on commit 6d79817

Please sign in to comment.