📖 docs: add installation instructions for mac and linux #1378
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -69,12 +69,29 @@ Language: You must have GoLang installed to run Scorecards (https://golang.org/d | |
|
|
||
| ### Installation | ||
|
|
||
| #### Standalone | ||
|
|
||
| To install Scorecards as a standalone: | ||
|
|
||
| 1. Visit our latest [release page](https://github.com/ossf/scorecard/releases/latest) and download the correct binary for your operating system | ||
| 2. Extract the binary file | ||
| 3. Add the binary to your `GOPATH/bin` directory (use `go env GOPATH` to identify your directory if necessary) | ||
|
|
||
| #### Using Homebrew | ||
|
|
||
| You can use [Homebrew](https://brew.sh/) (on macOS or Linux) to install Scorecards. | ||
|
|
||
| ```sh | ||
| brew install scorecard | ||
| ``` | ||
|
|
||
| ### Using Linux package managers | ||
|
|
||
| | Package Manager | Linux Distribution | Command | | ||
| |------------------------------------------------------------|--------------------|--------------------------------------------| | ||
| | Nix | NixOS | `nix-env -iA nixpkgs.scorecard` | | ||
|
There was a problem hiding this comment. Same question here. We don't have this setup AFAIK. There was a problem hiding this comment. It was submitted to nixpkgs1 by @06kellyjac FootnotesThere was a problem hiding this comment. Can we add this is maintained by the community https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/security/scorecard/default.nix? This will help with the expectations. There was a problem hiding this comment. pretty much any package via a package manager is maintained by the "community", excluding the big businesses such as RedHat, OpenSUSE, Canonical unless if you mean the distinction between the official arch repositories and the community AUR or the official brew repositories and separate casks. If that's the distinction we're using then this is an "official" package in the official nixpkgs, the AUR equivalent in nix/nixpkgs is the NUR. |
||
| | [AUR helper](https://wiki.archlinux.org/title/AUR_helpers) | Arch Linux | Use your AUR helper to install `scorecard` | | ||
|
|
||
| ### Authentication | ||
|
|
||
| Before running Scorecard, you need to either: | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this actually work? I thought we don't have homebrew setup. @developer-guy fyi
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like there is an existing https://formulae.brew.sh/formula/scorecard#default
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like this is also maintained by the community.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, in that case do we need #1376?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need this now. cc @developer-guy