Jason Dobry edited this page Sep 20, 2017 · 23 revisions
Google Inc. logo

Google Cloud Functions Emulator

NPM Tests Coverage

Disclaimer: This is not an official Google product.

Table of Contents

What is the Google Cloud Functions Emulator?

The Google Cloud Functions Emulator is a Node.js application that implements the Google Cloud Functions API, and includes a CLI with which you can manage the application.

The Emulator allows you to deploy, run, and debug your Cloud Functions on your local machine before deploying them to the production Google Cloud Functions service.

How do I get started?

  1. Write a function:

     mkdir helloWorld
     cd helloWorld
     touch index.js
     echo 'exports.helloWorld = (req, res) => res.send("Hello, World!");' > index.js
  2. Install the Emulator:


     npm install -g @google-cloud/functions-emulator


     yarn global add @google-cloud/functions-emulator

    Or read more in the detailed installation instructions.

  3. Start the Emulator:

     functions start

    Note: You can use the alias functions-emulator in the case that your PATH or shell already has a functions command.

  4. Deploy your function:

     functions deploy helloWorld --trigger-http

    Get help deploying a function with functions deploy --help.

  5. Call your function:

     functions call helloWorld
  6. View the logs:

     functions logs read

Where is the documentation?

For a quick reference, the Emulator CLI is self-documenting. Run the following to get help with the CLI:

functions --help

For everything else see the How-To Guides.


To give feedback, report a bug, or request a feature, please open an issue.

To contribute a change, check out the contributing guide.


Copyright 2017, Google, Inc.

Licensed under the Apache License, Version 2.0

See the full license.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.