0.11.0 • Public • Published

Google Cloud Platform logo

Google Compute Engine: Node.js Client

release level npm version codecov

Node.js idiomatic client for Compute Engine.

Compute Engine lets you create and run virtual machines on Google infrastructure. Compute Engine offers scale, performance, and value that allows you to easily launch large compute clusters on Google's infrastructure. There are no upfront investments and you can run thousands of virtual CPUs on a system that has been designed to be fast, and to offer strong consistency of performance.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.

    Go to the projects page

  2. Enable billing for your project.

    Enable billing

  3. Enable the Google Compute Engine API.

    Enable the API

  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install --save @google-cloud/compute

Using the client library

// Imports the Google Cloud client library
const Compute = require('@google-cloud/compute');

// Creates a client
const compute = new Compute();

// Create a new VM using the latest OS image of your choice.
const zone = compute.zone('us-central1-a');
const name = 'ubuntu-http';

  .createVM(name, {os: 'ubuntu'})
  .then(data => {
    // `operation` lets you check the status of long-running tasks.
    const vm = data[0];
    const operation = data[1];
    return operation.promise();
  .then(() => {
    // Virtual machine created!
  .catch(err => {
    console.error('ERROR:', err);


Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample Source Code Try it
Create Virtual Machine with Apache and Custom Homepage source code Open in Cloud Shell
List Virtual Machines source code Open in Cloud Shell

The Compute Engine Node.js Client API Reference documentation also contains samples.


This library follows Semantic Versioning.

This library is considered to be in alpha. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.


Apache Version 2.0


Package Sidebar


npm i @brainsights/gcloud-compute

Weekly Downloads






Unpacked Size

420 kB

Total Files


Last publish


  • modeswitch