-
Notifications
You must be signed in to change notification settings - Fork 115
Home
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:
functions --help
- How-To Guides
- CLI Docs:
- Contributing
- License
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.
-
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:
npm install -g @google-cloud/functions-emulator
Yarn:
yarn global add @google-cloud/functions-emulator
Or read more in the detailed installation instructions.
-
Start the Emulator:
functions start
Note: You can use the alias
functions-emulator
in the case that your PATH or shell already has afunctions
command. -
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
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.
Disclaimer: This is not an official Google product.
@google-cloud/functions-emulator is currently in pre-1.0.0 development. Before the 1.0.0 release, backwards compatible changes and bug fixes will bump the patch version number and breaking changes will bump the minor version number.