Official CLI for OpenFaaS

## faas-cli

[](https://travis-ci.com/openfaas/faas-cli)

[](https://goreportcard.com/report/github.com/openfaas/faas-cli)

[](https://opensource.org/licenses/MIT)

[](https://www.openfaas.com)

This is a CLI for use with [OpenFaaS](https://github.com/openfaas/faas) - a serverless functions framework for Docker & Kubernetes.

> Before using this tool please setup OpenFaaS by following instructions over on the main repo.

The CLI can be used to build and deploy functions to [OpenFaaS](https://github.com/openfaas/faas). You can build OpenFaaS functions from a set of supported language templates (such as Node.js, Python, CSharp and Ruby). That means you just write a handler file such as (handler.py/handler.js) and the CLI does the rest to create a Docker image.

Demo: [ASCII cinema](https://asciinema.org/a/141284)

### TL;DR - Introductory tutorial

[Blog: Coffee with the FaaS-CLI](https://blog.alexellis.io/quickstart-openfaas-cli/)

### Run the CLI

The main commands supported by the CLI are:

* `faas-cli new` - creates a new function via a template in the current directory

* `faas-cli login` - stores basic auth credentials for OpenFaaS gateway (supports multiple gateways)

* `faas-cli logout` - removes basic auth credentials for a given gateway

* `faas-cli up` - a combination of `build/push and deploy`

* `faas-cli build` - builds Docker images from the supported language types

* `faas-cli push` - pushes Docker images into a registry

* `faas-cli deploy` - deploys the functions into a local or remote OpenFaaS gateway