1
0
mirror of https://github.com/ko-build/ko.git synced 2025-11-23 22:35:11 +02:00
Files
ko-build/docs/install.md
koki-develop 7067ad211b Update setup-ko action link in install.md
Signed-off-by: koki-develop <kou.pg.0131@gmail.com>
2024-03-13 08:49:00 -04:00

76 lines
2.6 KiB
Markdown

# Installation
### Install from [GitHub Releases](https://github.com/ko-build/ko/releases)
```
$ VERSION=TODO # choose the latest version (without v prefix)
$ OS=Linux # or Darwin
$ ARCH=x86_64 # or arm64, i386, s390x
```
We generate [SLSA3 provenance](https://slsa.dev) using the OpenSSF's [slsa-framework/slsa-github-generator](https://github.com/slsa-framework/slsa-github-generator). To verify our release, install the verification tool from [slsa-framework/slsa-verifier#installation](https://github.com/slsa-framework/slsa-verifier#installation) and verify as follows:
```shell
$ curl -sSfL "https://github.com/ko-build/ko/releases/download/v${VERSION}/ko_${VERSION}_${OS}_${ARCH}.tar.gz" > ko.tar.gz
$ curl -sSfL https://github.com/ko-build/ko/releases/download/v${VERSION}/multiple.intoto.jsonl > multiple.intoto.jsonl
$ slsa-verifier verify-artifact --provenance-path multiple.intoto.jsonl --source-uri github.com/ko-build/ko --source-tag "v${VERSION}" ko.tar.gz
Verified signature against tlog entry index 24413745 at URL: https://rekor.sigstore.dev/api/v1/log/entries/24296fb24b8ad77ab97a5263b5fa8f35789618348a39358b1f9470b0c31045effbbe5e23e77a5836
Verified build using builder "https://github.com/slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@refs/tags/v1.7.0" at commit 200db7243f02b5c0303e21d8ab8e3b4ad3a229d0
Verifying artifact /Users/batuhanapaydin/workspace/ko/ko.tar.gz: PASSED
PASSED: Verified SLSA provenance
```
```shell
$ tar xzf ko.tar.gz ko
$ chmod +x ./ko
```
### Install using [Homebrew](https://brew.sh)
```plaintext
brew install ko
```
### Install using [MacPorts](https://www.macports.org)
```plaintext
sudo port install ko
```
More info [here](https://ports.macports.org/port/ko/)
### Install on Windows using [Scoop](https://scoop.sh)
```plaintext
scoop install ko
```
### Install on [Alpine Linux](https://www.alpinelinux.org)
Installation on Alpine requires using the [`testing` repository](https://wiki.alpinelinux.org/wiki/Enable_Community_Repository#Using_testing_repositories)
```
echo https://dl-cdn.alpinelinux.org/alpine/edge/testing/ >> /etc/apk/repositories
apk update
apk add ko
```
### Build and Install from source
With Go 1.16+, build and install the latest released version:
```plaintext
go install github.com/google/ko@latest
```
### Setup on GitHub Actions
You can use the [setup-ko](https://github.com/ko-build/setup-ko) action to install ko and setup auth to [GitHub Container Registry](https://github.com/features/packages) in a GitHub Action workflow:
```plaintext
steps:
- uses: ko-build/setup-ko@v0.6
```