Skip to content

Commit 37a4c73

Browse files
committed
cmd/multi-scorecard: Update installation command
Signed-off-by: Stephen Augustus <[email protected]>
1 parent 635d543 commit 37a4c73

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

cmd/multi-scorecard/README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
1-
# Multi Scorecard
1+
# `multi-scorecard`
22

3-
This program runs [OpenSSF Scorecard](https://github.com/ossf/scorecard) over
4-
many repositories using a [GitHub
5-
App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps)
6-
credential. GitHub is queried to determine the orgs and repos the app is
7-
installed on to determine which repos to run Scorecard over. Results are
8-
printed to stdout in a JSON array.
3+
This program runs OpenSSF Scorecard over many repositories using a [GitHub App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps) credential.
4+
GitHub is queried to determine the orgs and repos the app is installed on to determine which repos to run Scorecard over.
5+
6+
Results are printed to stdout in a JSON array.
97

108
## Usage
119

12-
A [GitHub
13-
App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps)
14-
must be created and installed on the repositories you wish to scan.
10+
A [GitHub App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps) must be created and installed on the repositories you wish to scan.
1511

1612
To install:
1713

18-
```
19-
go get github.com/jeffmendoza/multi-scorecard@latest
14+
```console
15+
go get github.com/ossf/scorecard/cmd/multi-scorecard@multi-scorecard
2016
```
2117

2218
To run:
2319

24-
```
20+
```console
2521
multi-scorecard -appid 1234 -keyfile my-app.private-key.pem > results.json
2622
```
2723

28-
Where `1234` is the App ID of the app, and `my-app.private-key.pem` is the
29-
private key file of the app.
24+
Where `1234` is the App ID of the app, and `my-app.private-key.pem` is the private key file of the app.

0 commit comments

Comments
 (0)