This repository has been archived and is no longer maintained.
We recommend you use:
- Google Cloud Functions: The functions framework which is the same library that powers functions for Node 10+.
- Google Cloud Functions for Firebase: The local emulator with
Please see Issue #327 for more details.
Google Cloud Functions Emulator
Disclaimer: This is not an official Google product.
Table of Contents
- What is the Google Cloud Functions Emulator?
- How do I get started?
- Where is the documentation?
- CLI Docs:
- How-To Guides
- CLI Docs:
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 only supports Node
v6.x.x. It does not support Node
v8.x.x or Python.
How do I get started?
Write a function:
mkdir helloWorld cd helloWorld touch index.js echo 'exports.helloWorld = (req, res) => res.send("Hello, World!");' > index.js
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.
Start the Emulator:
Deploy your function:
functions deploy helloWorld --trigger-http
Get help deploying a function with
functions deploy --help.
Call your function:
functions call helloWorld
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:
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.