We recommend installing faas-cli through arkade, for the quickest and easiest installation.
There is also a bash script for downloading the binary, and support for
Installation with arkade¶
curl -sSL https://get.arkade.dev | sudo -E sh
arkade get faas-cli
You can update faas-cli at any time by running the above command again.
arkade can also be used to download around 120 different DevOps and Kubernetes tools, find out more in the arkade README
Installation with Bash¶
For Linux or macOS users, the following script can be used:
curl -sSL https://cli.openfaas.com | sudo -E sh
-Eallows for any
http_proxyenvironmental variables to be passed through to the installation bash script.
Non-root with curl downloads the binary into your current directory and will then print installation instructions:
curl -sSL https://cli.openfaas.com | sh
brew install faas-cli
The version of faas-cli installed by
brew is likely to lag behind a little, so we recommend using arkade instead.
$version = (Invoke-WebRequest "https://api.github.com/repos/openfaas/faas-cli/releases/latest" | ConvertFrom-Json).tag_name (New-Object System.Net.WebClient).DownloadFile("https://github.com/openfaas/faas-cli/releases/download/$version/faas-cli.exe", "faas-cli.exe")
Environment variable overrides¶
Several overrides exist which will be used by default if set and no other command-line flag has been set.
OPENFAAS_TEMPLATE_URL- to set the default URL to pull templates from
OPENFAAS_PREFIX- for use with
faas-cli new- this can act in place of
OPENFAAS_URL- to override the default gateway URL
faas-cli with sudo¶
If you're running the faas-cli with
sudo we recommend using
sudo -E to pass through any environmental variables you may have configured such as a
faas-cli with docker¶
faas-cli is also available as a Docker image making it convenient for use in CI jobs such as with a Jenkins pipeline or a task in cron.
There is no "latest" tag, so find the version of the CLI you want to use from the tags page on the Docker Hub. These correspond to the release from GitHub.
Note: the Docker image cannot be used to perform a build directly, but you can use it to generate a build context which can be used with a container builder such as the OpenFaaS Pro Function Builder API, Docker, buildkit or Kaniko in another part of your build pipeline.
Use-cases for the Docker image:
- Generate the build context without running docker with the
faas-cli build --shrinkwrapcommand
- Deploy an existing image to a remote server
- Manage secrets with
- Invoke functions via cron with
- Check the health of your remote gateway with
Building from source¶
The contributing guide has instructions for building from source and for configuring a Golang development environment.
- Star/fork on GitHub: faas-cli