Installation

    Utility script with curl:

    Non-root with curl downloads the binary into your current directory and will then print installation instructions:

    Via brew:

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

    Windows

    In PowerShell:

    Several overrides exist which will be used by default if set and no other command-line flag has been set.

    • - to set the default URL to pull templates from
    • OPENFAAS_PREFIX - for use with faas-cli new - this can act in place of —prefix

    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, or no_proxy entry.

    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

    Building from source