Install Docker Cli

You can install the CLI with a curl utility script, brew or by downloading the binary from the releases page. Once installed you'll get the faas-cli command and faas alias.

The Docker Desktop installation includes Docker Engine, Docker CLI client, Docker Compose, Notary, Kubernetes, and Credential Helper. Containers and images created with Docker Desktop are shared between all user accounts on machines where it is installed. This sample Docker Compose file brings up a three-node Elasticsearch cluster. Node es01 listens on localhost:9200 and es02 and es03 talk to es01 over a Docker network. Please note that this configuration exposes port 9200 on all network interfaces, and given how Docker manipulates iptables on Linux, this means that your Elasticsearch cluster is publically accessible, potentially ignoring any.

Linux or macOS¶

Utility script with curl:

The flag -E allows for any http_proxy environmental 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:

Via brew:

Note

The brew release may not run the latest minor release but is updated regularly.

Windows¶

In PowerShell:

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 --prefix
OPENFAAS_URL - to override the default gateway URL

Running `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 http_proxy, https_proxy or no_proxy entry.

Docker image¶

The 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 Docker, buildkit or Kaniko in another part of your build pipeline.

Use-cases for the Docker image:

Generate the build context without running docker build - faas-cli --shrinkwrap
Deploy an existing image to a remote server faas-cli deploy
Manage secrets with faas-cli secret
Invoke functions via cron with faas-cli invoke
Check the health of your remote gateway with faas-cli info

Building from source¶

The contributing guide has instructions for building from source and for configuring a Golang development environment.