Installing Knative Functions¶
You can install Knative Functions either by using the standalone func
CLI, or by installing the kn func
plugin that is available for the Knative kn
CLI.
Installing the func
CLI¶
To install func
using Homebrew, run the following commands:
brew tap knative-extensions/kn-plugins
brew install func
If you have already installed the kn
CLI by using Homebrew, the func
CLI is automatically recognized as a plugin to kn
, and can be referenced as kn func
or func
interchangeably.
Note
Use brew upgrade
instead if you are upgrading from a previous version.
You can install func
by downloading the executable binary for your system and placing it in the system path.
-
Download the binary for your system from the
func
release page. -
Rename the binary to
func
and make it executable by running the following commands:mv <path-to-binary-file> func
chmod +x func
Where
<path-to-binary-file>
is the path to the binary file you downloaded in the previous step, for example,func_darwin_amd64
orfunc_linux_amd64
. -
Move the executable binary file to a directory on your PATH by running the command:
mv func /usr/local/bin
-
Verify that the CLI is working by running the command:
func version
-
Check out the
func
client repository and navigate to thefunc
directory:git clone https://github.com/knative/func.git func
cd func/
-
Build an executable binary:
make
-
Move
func
into your system path, and verify thatfunc
commands are working properly. For example:func version
Run func
from a container image. For example:
docker run --rm -it ghcr.io/knative/func/func create -l node -t http myfunc
Links to images are available here:
Note
Running func
from a container image does not place the binary on a permanent path. This procedure must be repeated each time you want to use func
.
Installing the kn func
CLI plugin¶
You can install Knative Functions as a kn
CLI plugin, by downloading the executable binary for your system and placing it in the system path.
-
Download the binary for your system from the
func
release page. -
Rename the binary to
kn-func
, and make it executable by running the following commands:mv <path-to-binary-file> kn-func
chmod +x kn-func
Where
<path-to-binary-file>
is the path to the binary file you downloaded in the previous step, for example,func_darwin_amd64
orfunc_linux_amd64
. -
Move the executable binary file to a directory on your PATH by running the command:
mv kn-func /usr/local/bin
-
Verify that the CLI is working by running the command:
kn func version