Skip to content

Improve "Installing the Knative CLI" #2230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
knative-prow-robot merged 1 commit into from
Jul 7, 2020
Merged

Improve "Installing the Knative CLI" #2230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/install/install-kn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,26 @@ To install the `kn` Client, you must download the executable binary for your sys

You must place the executable binary in your system path, and make sure that it is executable.

## Install `kn` using Go
**Prerequisite:** Building `kn` requires Go v1.14 or newer. You will first need a working Go environment.
1. Check out the [Client repository](https://github.com/knative/client):
```bash
git clone https://github.com/knative/client.git
Comment thread
MIBc marked this conversation as resolved.
cd client/
```
1. Build an executable binary:
```bash
hack/build.sh -f
```
1. Move `kn` into your system path, and verify that `kn` commands are working properly. For example:
```bash
kn version
```
Comment thread
MIBc marked this conversation as resolved.

## Install `kn` using brew

For macOs, you can [install kn using brew.](https://github.com/knative/homebrew-client)

## `kn` container images

The `kn` container images are available for users who require these for additional use cases. For example, if you want to use the `kn` container image with [Tekton](https://github.com/tektoncd/catalog/tree/master/kn).
Expand All @@ -34,3 +54,16 @@ Links to either the nightly container image or the latest stable container image

- [Nightly container image](https://gcr.io/knative-nightly/knative.dev/client/cmd/kn)
- [Latest release](https://gcr.io/knative-releases/knative.dev/client/cmd/kn)

You can run `kn` from a container image. For example:
```bash
docker run --rm -v "$HOME/.kube/config:/root/.kube/config" gcr.io/knative-releases/knative.dev/client/cmd/kn:latest service list
```

## Using `kn` with Tekton

You can also [run kn using Tekton](https://github.com/tektoncd/catalog/tree/master/kn).

## What's next
To learn more about using `kn`, see the [documentation](https://github.com/knative/client/blob/master/docs/cmd/kn.md).