Home

Google Cloud Functions Emulator

Disclaimer: This is not an official Google product.

Table of Contents

• What is this?
• How do I get started?
• Where is the documentation?
  • CLI Docs: functions --help
  • How-To Guides

What is this?

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. (Optional, but recommended) Sign up for the Google Cloud Functions Alpha and explore the Cloud Functions Documentation.

2. Write a function:

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

3. Install the Emulator:

   NPM:

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

   Yarn:

    yarn global add @google-cloud/functions-emulator
   

   Or read more in the detailed installation instructions.

4. Start the Emulator:

    functions start
   

5. Deploy your function:

    functions deploy helloWorld --trigger-http
   

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

6. Call your function:

    functions call helloWorld
   

7. 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.